Access Rules
Access Tokens
Agent Conversations
App Invites
Apps
Attributes
Authentication
- POSTAuthenticate a user based on a Stytch session token (B2B version)
- POSTRegister a user based on a Stytch session token (B2B)
- POSTReport whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side (B2B)
- POSTExchange a user token for a token scoped to a different company
- POSTAuthenticate a user based on a Stytch session token
- POSTRegister a user based on a Stytch session token
- POSTReport whether the user associatd to a Stytch OAuth or Magic Links token has been fully registered on Narrative side
Company
Company Marketing Information
Compute Pools
Connections
Contracts
Data Planes
- GETList data planes
- POSTCreate a data plane
- GETGet a data plane by ID
- DELArchive a data plane
- POSTData plane heartbeat
- POSTTrigger a health check
- PUTReplace the collaborators on a data plane
- PUTAdd a collaborator to a data plane
- DELRemove a collaborator from a data plane
- PUTSet the default compute pool for a data plane
- DELClear the default compute pool for a data plane
Data Shops
Data Streams
- POSTCreate a data-stream.
- GETGet a data-stream by its id.
- PUTUpdate a data-stream.
- POSTFetch many data-streams
- GETGet all data-streams for a company.
- GETGet all data-streams for a company given a search expression.
- GETGets the data-stream for a given company and slug.
- GETGet schema
- GETGet all data-streams for the given company and its data-shop hostname.
- GETFind data-streams for the given company and its data-shop hostname and the given search expression.
- GETGet all data-streams for a company given a sales channel
- GETFind data-streams for the given company and a sales-channel and the given search expression.
- GETFind data-streams available on the data-streams-market.
Dataset Configuration
Dataset Mappings
Dataset Refresh
Dataset Samples
Dataset Statistics
Datasets
- GETGet datasets
- PUTUpdate a dataset
- POSTCreate a dataset
- GETGet a dataset
- PUTUpdate a dataset
- DELDelete a dataset
- PUTActivate a dataset
- POSTActivate a datasetdeprecated
- POSTTruncate a dataset
- GETGet admin info for a dataset
- POSTUpdate a dataset's partition spec
- GETGet dataset statistics
- GETGet detailed statistics
- PUTCreate or Update detailed statistics
- POSTSubmit recalculation
- POSTIngest a file
- GETMetrics
- GETMetrics
- GETGet Metrics Configuration
- PUTPut Metrics Configuration
- DELDisable configuration
- PUTDerive the configuration
- POSTEnable configuration
- GETList connector interfaces compatible with a dataset
Destinations
Encryption Materials
Installations
Mappings
Model Inference
Payment Methods
Permissions
Products
Profiles
Queries
Schema Inference
Schema Presets
Subscriptions
- GETGet subscriptions
- POSTCreate a subscription
- GETGet cost forecasts
- POSTCreate a cost forecast
- GETGet a cost forecast
- POSTGet matches
- GETGet a subscription
- PUTUpdate a subscription
- DELDelete a subscription
- POSTActivate a subscription
- POSTCancel a subscription
- POSTCheckout a subscription
- GETGet subscription cost forecasts
- POSTCreate a cost forecast for a subscription
- GETGet deliveries
- POSTGet a delivered file
- GETGet subscription matches
- GETGet schema
Uploads
Webhooks
Whoami
Get an installation
curl --request GET \
--url https://api-dev.narrative.io/installations/{installation_id} \
--header 'Authorization: Bearer <token>'{
"id": 12345,
"app_id": 67,
"company_id": 345,
"tier_id": "basic",
"permissions": [
{
"access": "read",
"resource": "datasets"
},
{
"access": "write",
"resource": "destinations"
}
],
"installation_time": "2024-01-15T10:30:00"
}Installations
Get an installation
Returns a single installation by its ID.
The installation must belong to the authenticated company.
GET
/
installations
/
{installation_id}
Get an installation
curl --request GET \
--url https://api-dev.narrative.io/installations/{installation_id} \
--header 'Authorization: Bearer <token>'{
"id": 12345,
"app_id": 67,
"company_id": 345,
"tier_id": "basic",
"permissions": [
{
"access": "read",
"resource": "datasets"
},
{
"access": "write",
"resource": "destinations"
}
],
"installation_time": "2024-01-15T10:30:00"
}Documentation Index
Fetch the complete documentation index at: https://docs.narrative.io/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier for the installation.
Response
Successfully retrieved the installation.
An installation represents an app that has been installed for a company.
Unique identifier for the installation.
Example:
12345
The ID of the installed app.
Example:
67
The ID of the company that installed the app.
Example:
345
The tier selected during installation.
Example:
"basic"
The permissions granted to this installation.
Show child attributes
Show child attributes
The timestamp when the installation occurred.
Example:
"2024-01-15T10:30:00"
Was this page helpful?
⌘I