List endpoints
get
/api/endpointsResponse codes
- 200
Response (200)
[
{
"cache_duration_seconds": 42,
"enable_auth": true,
"inserted_at": "2021-12-31T23:34:00Z",
"max_limit": 42,
"name": "lorem",
"proactive_requerying_seconds": 42,
"query": "lorem",
"sandboxable": true,
"source_mapping": {},
"token": "lorem",
"updated_at": "2021-12-31T23:34:00Z"
}
]Create endpoint
post
/api/endpointsBody
- cache_duration_secondsOptionalinteger
- enable_authOptionalboolean
- inserted_atOptionalstring
- max_limitOptionalinteger
- nameRequiredstring
- proactive_requerying_secondsOptionalinteger
- queryRequiredstring
- sandboxableOptionalboolean
- source_mappingOptionalobject
- tokenOptionalstring
- updated_atOptionalstring
Response codes
- 201
- 404
Response (201)
{
"cache_duration_seconds": 42,
"enable_auth": true,
"inserted_at": "2021-12-31T23:34:00Z",
"max_limit": 42,
"name": "lorem",
"proactive_requerying_seconds": 42,
"query": "lorem",
"sandboxable": true,
"source_mapping": {},
"token": "lorem",
"updated_at": "2021-12-31T23:34:00Z"
}Delete endpoint
delete
/api/endpoints/{token}Path parameters
- tokenRequiredstring
Endpoint Token
Response codes
- 204
- 404
Response (204)
{}Fetch endpoint
get
/api/endpoints/{token}Path parameters
- tokenRequiredstring
Endpoint Token
Response codes
- 200
- 404
Response (200)
{
"cache_duration_seconds": 42,
"enable_auth": true,
"inserted_at": "2021-12-31T23:34:00Z",
"max_limit": 42,
"name": "lorem",
"proactive_requerying_seconds": 42,
"query": "lorem",
"sandboxable": true,
"source_mapping": {},
"token": "lorem",
"updated_at": "2021-12-31T23:34:00Z"
}Update endpoint
put
/api/endpoints/{token}Path parameters
- tokenRequiredstring
Endpoint Token
Body
- cache_duration_secondsOptionalinteger
- enable_authOptionalboolean
- inserted_atOptionalstring
- max_limitOptionalinteger
- nameRequiredstring
- proactive_requerying_secondsOptionalinteger
- queryRequiredstring
- sandboxableOptionalboolean
- source_mappingOptionalobject
- tokenOptionalstring
- updated_atOptionalstring
Response codes
- 201
- 404
Response (201)
{
"cache_duration_seconds": 42,
"enable_auth": true,
"inserted_at": "2021-12-31T23:34:00Z",
"max_limit": 42,
"name": "lorem",
"proactive_requerying_seconds": 42,
"query": "lorem",
"sandboxable": true,
"source_mapping": {},
"token": "lorem",
"updated_at": "2021-12-31T23:34:00Z"
}List sources
get
/api/sourcesResponse codes
- 200
Response (200)
{
"items": {
"properties": {
"api_quota": {
"type": "integer"
},
"bigquery_table_ttl": {
"type": "integer"
},
"bq_table_id": {
"type": "string"
},
"bq_table_schema": {
"type": "object"
},
"custom_event_message_keys": {
"type": "string"
},
"favorite": {
"type": "boolean"
},
"has_rejected_events": {
"type": "boolean"
},
"id": {},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"metrics": {
"type": "object"
},
"name": {
"type": "string"
},
"notifications": {
"items": {
"properties": {
"other_email_notifications": {
"type": "string"
},
"team_user_ids_for_email": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_schema_updates": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_sms": {
"allOf": {
"type": "string"
},
"type": "array"
},
"user_email_notifications": {
"type": "boolean"
},
"user_schema_update_notifications": {
"type": "boolean"
},
"user_text_notifications": {
"type": "boolean"
}
},
"title": "Notification",
"type": "object"
},
"type": "array"
},
"public_token": {
"type": "string"
},
"slack_hook_url": {
"type": "string"
},
"token": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook_notification_url": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Source",
"type": "object"
},
"type": "array"
}Create source
post
/api/sourcesBody
- api_quotaOptionalinteger
- bigquery_table_ttlOptionalinteger
- bq_table_idOptionalstring
- bq_table_schemaOptionalobject
- custom_event_message_keysOptionalstring
- favoriteOptionalboolean
- has_rejected_eventsOptionalboolean
- idOptional
- inserted_atOptionalstring
- metricsOptionalobject
- nameRequiredstring
- notificationsOptionalArray<object>
- public_tokenOptionalstring
- slack_hook_urlOptionalstring
- tokenOptionalstring
- updated_atOptionalstring
- webhook_notification_urlOptionalstring
Response codes
- 201
- 404
Response (201)
{
"properties": {
"api_quota": {
"type": "integer"
},
"bigquery_table_ttl": {
"type": "integer"
},
"bq_table_id": {
"type": "string"
},
"bq_table_schema": {
"type": "object"
},
"custom_event_message_keys": {
"type": "string"
},
"favorite": {
"type": "boolean"
},
"has_rejected_events": {
"type": "boolean"
},
"id": {},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"metrics": {
"type": "object"
},
"name": {
"type": "string"
},
"notifications": {
"items": {
"properties": {
"other_email_notifications": {
"type": "string"
},
"team_user_ids_for_email": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_schema_updates": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_sms": {
"allOf": {
"type": "string"
},
"type": "array"
},
"user_email_notifications": {
"type": "boolean"
},
"user_schema_update_notifications": {
"type": "boolean"
},
"user_text_notifications": {
"type": "boolean"
}
},
"title": "Notification",
"type": "object"
},
"type": "array"
},
"public_token": {
"type": "string"
},
"slack_hook_url": {
"type": "string"
},
"token": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook_notification_url": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Source",
"type": "object"
}Delete source
delete
/api/sources/{token}Path parameters
- tokenRequiredstring
Source Token
Response codes
- 204
- 404
Response (204)
{}Fetch source
get
/api/sources/{token}Path parameters
- tokenRequiredstring
Source Token
Response codes
- 200
- 404
Response (200)
{
"properties": {
"api_quota": {
"type": "integer"
},
"bigquery_table_ttl": {
"type": "integer"
},
"bq_table_id": {
"type": "string"
},
"bq_table_schema": {
"type": "object"
},
"custom_event_message_keys": {
"type": "string"
},
"favorite": {
"type": "boolean"
},
"has_rejected_events": {
"type": "boolean"
},
"id": {},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"metrics": {
"type": "object"
},
"name": {
"type": "string"
},
"notifications": {
"items": {
"properties": {
"other_email_notifications": {
"type": "string"
},
"team_user_ids_for_email": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_schema_updates": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_sms": {
"allOf": {
"type": "string"
},
"type": "array"
},
"user_email_notifications": {
"type": "boolean"
},
"user_schema_update_notifications": {
"type": "boolean"
},
"user_text_notifications": {
"type": "boolean"
}
},
"title": "Notification",
"type": "object"
},
"type": "array"
},
"public_token": {
"type": "string"
},
"slack_hook_url": {
"type": "string"
},
"token": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook_notification_url": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Source",
"type": "object"
}Update source
put
/api/sources/{token}Path parameters
- tokenRequiredstring
Source Token
Body
- api_quotaOptionalinteger
- bigquery_table_ttlOptionalinteger
- bq_table_idOptionalstring
- bq_table_schemaOptionalobject
- custom_event_message_keysOptionalstring
- favoriteOptionalboolean
- has_rejected_eventsOptionalboolean
- idOptional
- inserted_atOptionalstring
- metricsOptionalobject
- nameRequiredstring
- notificationsOptionalArray<object>
- public_tokenOptionalstring
- slack_hook_urlOptionalstring
- tokenOptionalstring
- updated_atOptionalstring
- webhook_notification_urlOptionalstring
Response codes
- 201
- 404
Response (201)
{
"properties": {
"api_quota": {
"type": "integer"
},
"bigquery_table_ttl": {
"type": "integer"
},
"bq_table_id": {
"type": "string"
},
"bq_table_schema": {
"type": "object"
},
"custom_event_message_keys": {
"type": "string"
},
"favorite": {
"type": "boolean"
},
"has_rejected_events": {
"type": "boolean"
},
"id": {},
"inserted_at": {
"format": "date-time",
"type": "string"
},
"metrics": {
"type": "object"
},
"name": {
"type": "string"
},
"notifications": {
"items": {
"properties": {
"other_email_notifications": {
"type": "string"
},
"team_user_ids_for_email": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_schema_updates": {
"allOf": {
"type": "string"
},
"type": "array"
},
"team_user_ids_for_sms": {
"allOf": {
"type": "string"
},
"type": "array"
},
"user_email_notifications": {
"type": "boolean"
},
"user_schema_update_notifications": {
"type": "boolean"
},
"user_text_notifications": {
"type": "boolean"
}
},
"title": "Notification",
"type": "object"
},
"type": "array"
},
"public_token": {
"type": "string"
},
"slack_hook_url": {
"type": "string"
},
"token": {
"type": "string"
},
"updated_at": {
"format": "date-time",
"type": "string"
},
"webhook_notification_url": {
"type": "string"
}
},
"required": [
"name"
],
"title": "Source",
"type": "object"
}List teams
get
/api/teamsResponse codes
- 200
Response (200)
[
{
"name": "lorem",
"team_users": [
{
"email": "lorem",
"name": "lorem"
}
],
"token": "lorem",
"user": {
"api_key": "lorem",
"api_quota": 42,
"bigquery_dataset_id": "lorem",
"bigquery_dataset_location": "lorem",
"bigquery_project_id": "lorem",
"company": "lorem",
"email": "lorem",
"email_me_product": true,
"email_preferred": "lorem",
"image": "lorem",
"name": "lorem",
"phone": "lorem",
"provider": "lorem",
"token": "lorem"
}
}
]Create Team
post
/api/teamsBody
- nameRequiredstring
- team_usersOptionalArray<object>
- tokenOptionalstring
- userOptionalobject
Response codes
- 201
- 404
Response (201)
{
"name": "lorem",
"team_users": [
{
"email": "lorem",
"name": "lorem"
}
],
"token": "lorem",
"user": {
"api_key": "lorem",
"api_quota": 42,
"bigquery_dataset_id": "lorem",
"bigquery_dataset_location": "lorem",
"bigquery_project_id": "lorem",
"company": "lorem",
"email": "lorem",
"email_me_product": true,
"email_preferred": "lorem",
"image": "lorem",
"name": "lorem",
"phone": "lorem",
"provider": "lorem",
"token": "lorem"
}
}Delete Team
delete
/api/teams/{token}Path parameters
- tokenRequiredstring
Team Token
Response codes
- 204
- 404
Response (204)
{}Fetch team
get
/api/teams/{token}Path parameters
- tokenRequiredstring
Team Token
Response codes
- 200
- 404
Response (200)
{
"name": "lorem",
"team_users": [
{
"email": "lorem",
"name": "lorem"
}
],
"token": "lorem",
"user": {
"api_key": "lorem",
"api_quota": 42,
"bigquery_dataset_id": "lorem",
"bigquery_dataset_location": "lorem",
"bigquery_project_id": "lorem",
"company": "lorem",
"email": "lorem",
"email_me_product": true,
"email_preferred": "lorem",
"image": "lorem",
"name": "lorem",
"phone": "lorem",
"provider": "lorem",
"token": "lorem"
}
}Update team
put
/api/teams/{token}Path parameters
- tokenRequiredstring
Team Token
Body
- nameRequiredstring
- team_usersOptionalArray<object>
- tokenOptionalstring
- userOptionalobject
Response codes
- 201
- 404
Response (201)
{
"name": "lorem",
"team_users": [
{
"email": "lorem",
"name": "lorem"
}
],
"token": "lorem",
"user": {
"api_key": "lorem",
"api_quota": 42,
"bigquery_dataset_id": "lorem",
"bigquery_dataset_location": "lorem",
"bigquery_project_id": "lorem",
"company": "lorem",
"email": "lorem",
"email_me_product": true,
"email_preferred": "lorem",
"image": "lorem",
"name": "lorem",
"phone": "lorem",
"provider": "lorem",
"token": "lorem"
}
}