Lightdash API (0.600.0)
Open API documentation for all public Lightdash API endpoints
CreateEmailOneTimePasscode
Create a new one-time passcode for the current user's primary email. The user will receive an email with the passcode.
Responses
Response samples
- 200
- default
{- "results": {
- "otp": {
- "numberOfAttempts": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "isMaxAttempts": true,
- "isExpired": true,
- "expiresAt": "2019-08-24T14:15:22Z"
}, - "isVerified": true,
- "email": "string"
}, - "status": "ok"
}
GetEmailVerificationStatus
Get the verification status for the current user's primary email
query Parameters
passcode | string the one-time passcode sent to the user's primary email |
Responses
Response samples
- 200
- default
{- "results": {
- "otp": {
- "numberOfAttempts": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "isMaxAttempts": true,
- "isExpired": true,
- "expiresAt": "2019-08-24T14:15:22Z"
}, - "isVerified": true,
- "email": "string"
}, - "status": "ok"
}
ListMyAvailableOrganizations
List the organizations that the current user can join. This is based on the user's primary email domain and the organization's allowed email domains.
Responses
Response samples
- 200
- default
{- "results": [
- {
- "membersCount": 0,
- "name": "string",
- "organizationUuid": "string"
}
], - "status": "ok"
}
JoinOrganization
Add the current user to an organization that accepts users with a verified email domain. This will fail if the organization email domain does not match the user's primary email domain.
path Parameters
organizationUuid required | string the uuid of the organization to join |
Responses
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
Each user is a member of a single organization. These routes allow users to manage their organization. Most actions are only available to admin users.
CreateOrganization
Creates a new organization, the current user becomes the Admin of the new organization. This is only available to users that are not already in an organization.
Request Body schema: application/json
the new organization settings
name required | string The name of the organization |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
UpdateMyOrganization
Update the current user's organization
Request Body schema: application/json
the new organization settings
name | string The name of the organization |
chartColors | Array of strings The default color palette for all projects in the organization |
Responses
Request samples
- Payload
{- "name": "string",
- "chartColors": [
- "string"
]
}
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
Response samples
- 200
- default
{- "results": [
- {
- "isInviteExpired": true,
- "isActive": true,
- "role": "member",
- "organizationUuid": "string",
- "email": "string",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}
], - "status": "ok"
}
UpdateOrganizationMember
Updates the membership profile for a user in the current user's organization
path Parameters
userUuid required | string the uuid of the user to update |
Request Body schema: application/json
the new membership profile
role | string (OrganizationMemberRole) Enum: "member" "viewer" "interactive_viewer" "editor" "developer" "admin" |
Responses
Request samples
- Payload
{- "role": "member"
}
Response samples
- 200
- default
{- "results": {
- "isInviteExpired": true,
- "isActive": true,
- "role": "member",
- "organizationUuid": "string",
- "email": "string",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}, - "status": "ok"
}
UpdateOrganizationEmailDomains
Gets the allowed email domains for the current user's organization
Request Body schema: application/json
role required | string (OrganizationMemberRole) Enum: "member" "viewer" "interactive_viewer" "editor" "developer" "admin" |
emailDomains required | Array of strings |
projectUuids required | Array of strings |
Responses
Request samples
- Payload
{- "role": "member",
- "emailDomains": [
- "string"
], - "projectUuids": [
- "string"
]
}
Response samples
- 200
- default
{- "results": {
- "projectUuids": [
- "string"
], - "role": "member",
- "emailDomains": [
- "string"
], - "organizationUuid": "string"
}, - "status": "ok"
}
CreateGroupInOrganization
Creates a new group in the current user's organization
Request Body schema: application/json
name required | string A friendly name for the group |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 200
- default
{- "results": {
- "organizationUuid": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "uuid": "string"
}, - "status": "ok"
}
Projects belong to a single organization. These routes allow users to manage their projects, browse content, and execute queries. Users inside an organization might have access to a project from an organization-level role or they might be granted access to a project directly.
ListChartsInProject
List all charts in a project
path Parameters
projectUuid required | string The uuid of the project to get charts for |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "description": "string",
- "projectUuid": "string",
- "spaceUuid": "string",
- "pinnedListUuid": "string",
- "spaceName": "string"
}
], - "status": "ok"
}
ListSpacesInProject
List all spaces in a project
path Parameters
projectUuid required | string The uuid of the project to get spaces for |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "projectUuid": "string",
- "isPrivate": true,
- "access": [
- "string"
]
}
], - "status": "ok"
}
GetProjectAccessList
Get access list for a project. This is a list of users that have been explictly granted access to the project. There may be other users that have access to the project via their organization membership.
path Parameters
projectUuid required | string |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "lastName": "string",
- "firstName": "string",
- "email": "string",
- "role": "viewer",
- "projectUuid": "string",
- "userUuid": "string"
}
], - "status": "ok"
}
GrantProjectAccessToUser
Grant a user access to a project
path Parameters
projectUuid required | string |
Request Body schema: application/json
sendEmail required | boolean |
role required | string (ProjectMemberRole) Enum: "viewer" "interactive_viewer" "editor" "developer" "admin" |
email required | string |
Responses
Request samples
- Payload
{- "sendEmail": true,
- "role": "viewer",
- "email": "string"
}
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
UpdateProjectAccessForUser
Update a user's access to a project
path Parameters
projectUuid required | string |
userUuid required | string |
Request Body schema: application/json
role required | string (ProjectMemberRole) Enum: "viewer" "interactive_viewer" "editor" "developer" "admin" |
Responses
Request samples
- Payload
{- "role": "viewer"
}
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
ValidateProject
Validate content inside a project. This will start a validation job and return the job id.
Validation jobs scan all charts and dashboards inside a project to find any broken references to metrics or dimensions that aren't available. Results are available after the job is completed.
path Parameters
projectUuid required | string the projectId for the validation |
Responses
Response samples
- 200
- default
{- "results": {
- "jobId": "string"
}, - "status": "ok"
}
GetLatestValidationResults
Get validation results for a project. This will return the results of the latest validation job.
path Parameters
projectUuid required | string the projectId for the validation |
query Parameters
fromSettings | boolean boolean to know if this request is made from the settings page, for analytics |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "spaceUuid": "string",
- "projectUuid": "string",
- "errorType": "chart",
- "error": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "validationId": 0,
- "chartViews": 0,
- "lastUpdatedAt": "2019-08-24T14:15:22Z",
- "lastUpdatedBy": "string",
- "fieldName": "string",
- "chartType": "line",
- "chartUuid": "string"
}
], - "status": "ok"
}
Spaces allow you to organize charts and dashboards within a project. They also allow granular access to content by allowing you to create private spaces, which are only accessible to the creator and admins.
CreateSpaceInProject
Create a new space inside a project
path Parameters
projectUuid required | string The uuid of the space's parent project |
Request Body schema: application/json
name required | string |
isPrivate | boolean |
Array of objects (SpaceShare) |
Responses
Request samples
- Payload
{- "name": "string",
- "isPrivate": true,
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
]
}
Response samples
- 200
- default
{- "results": {
- "pinnedListOrder": 0,
- "pinnedListUuid": "string",
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
], - "dashboards": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "projectUuid": "string",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}
], - "projectUuid": "string",
- "queries": [
- {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "views": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
], - "chartType": "line"
}
], - "isPrivate": true,
- "name": "string",
- "uuid": "string",
- "organizationUuid": "string"
}, - "status": "ok"
}
GetSpace
Get details for a space in a project
path Parameters
projectUuid required | string The uuid of the space's parent project |
spaceUuid required | string The uuid of the space to get |
Responses
Response samples
- 200
- default
{- "results": {
- "pinnedListOrder": 0,
- "pinnedListUuid": "string",
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
], - "dashboards": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "projectUuid": "string",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}
], - "projectUuid": "string",
- "queries": [
- {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "views": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
], - "chartType": "line"
}
], - "isPrivate": true,
- "name": "string",
- "uuid": "string",
- "organizationUuid": "string"
}, - "status": "ok"
}
UpdateSpace
Update a space in a project
path Parameters
projectUuid required | string The uuid of the space's parent project |
spaceUuid required | string The uuid of the space to update |
Request Body schema: application/json
name required | string |
isPrivate required | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "isPrivate": true
}
Response samples
- 200
- default
{- "results": {
- "pinnedListOrder": 0,
- "pinnedListUuid": "string",
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
], - "dashboards": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "projectUuid": "string",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}
], - "projectUuid": "string",
- "queries": [
- {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "views": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
], - "chartType": "line"
}
], - "isPrivate": true,
- "name": "string",
- "uuid": "string",
- "organizationUuid": "string"
}, - "status": "ok"
}
These routes allow users to manage roles and permissions for their organization.
UpdateOrganizationMember
Updates the membership profile for a user in the current user's organization
path Parameters
userUuid required | string the uuid of the user to update |
Request Body schema: application/json
the new membership profile
role | string (OrganizationMemberRole) Enum: "member" "viewer" "interactive_viewer" "editor" "developer" "admin" |
Responses
Request samples
- Payload
{- "role": "member"
}
Response samples
- 200
- default
{- "results": {
- "isInviteExpired": true,
- "isActive": true,
- "role": "member",
- "organizationUuid": "string",
- "email": "string",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}, - "status": "ok"
}
CreateSpaceInProject
Create a new space inside a project
path Parameters
projectUuid required | string The uuid of the space's parent project |
Request Body schema: application/json
name required | string |
isPrivate | boolean |
Array of objects (SpaceShare) |
Responses
Request samples
- Payload
{- "name": "string",
- "isPrivate": true,
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
]
}
Response samples
- 200
- default
{- "results": {
- "pinnedListOrder": 0,
- "pinnedListUuid": "string",
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
], - "dashboards": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "projectUuid": "string",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}
], - "projectUuid": "string",
- "queries": [
- {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "views": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
], - "chartType": "line"
}
], - "isPrivate": true,
- "name": "string",
- "uuid": "string",
- "organizationUuid": "string"
}, - "status": "ok"
}
GetProjectAccessList
Get access list for a project. This is a list of users that have been explictly granted access to the project. There may be other users that have access to the project via their organization membership.
path Parameters
projectUuid required | string |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "lastName": "string",
- "firstName": "string",
- "email": "string",
- "role": "viewer",
- "projectUuid": "string",
- "userUuid": "string"
}
], - "status": "ok"
}
GrantProjectAccessToUser
Grant a user access to a project
path Parameters
projectUuid required | string |
Request Body schema: application/json
sendEmail required | boolean |
role required | string (ProjectMemberRole) Enum: "viewer" "interactive_viewer" "editor" "developer" "admin" |
email required | string |
Responses
Request samples
- Payload
{- "sendEmail": true,
- "role": "viewer",
- "email": "string"
}
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
UpdateProjectAccessForUser
Update a user's access to a project
path Parameters
projectUuid required | string |
userUuid required | string |
Request Body schema: application/json
role required | string (ProjectMemberRole) Enum: "viewer" "interactive_viewer" "editor" "developer" "admin" |
Responses
Request samples
- Payload
{- "role": "viewer"
}
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
UpdateSpace
Update a space in a project
path Parameters
projectUuid required | string The uuid of the space's parent project |
spaceUuid required | string The uuid of the space to update |
Request Body schema: application/json
name required | string |
isPrivate required | boolean |
Responses
Request samples
- Payload
{- "name": "string",
- "isPrivate": true
}
Response samples
- 200
- default
{- "results": {
- "pinnedListOrder": 0,
- "pinnedListUuid": "string",
- "access": [
- {
- "role": "viewer",
- "lastName": "string",
- "firstName": "string",
- "userUuid": "string"
}
], - "dashboards": [
- {
- "name": "string",
- "organizationUuid": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "projectUuid": "string",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}
], - "projectUuid": "string",
- "queries": [
- {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "views": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
], - "chartType": "line"
}
], - "isPrivate": true,
- "name": "string",
- "uuid": "string",
- "organizationUuid": "string"
}, - "status": "ok"
}
getDbtCloudMetrics
Get a list of dbt metric definitions from the dbt Cloud metadata api. The metrics are taken from the metadata from a single dbt Cloud job configured with the dbt Cloud integration settings for the project.
path Parameters
projectUuid required | string |
Responses
Response samples
- 200
- default
{- "results": {
- "metrics": [
- {
- "label": "string",
- "timeGrains": [
- "string"
], - "description": "string",
- "dimensions": [
- "string"
], - "name": "string",
- "uniqueId": "string"
}
]
}, - "status": "ok"
}
updateGroup
Update a group
path Parameters
groupUuid required | string |
Request Body schema: application/json
name required | string A friendly name for the group |
Responses
Request samples
- Payload
{- "name": "string"
}
Response samples
- 200
- default
{- "results": {
- "organizationUuid": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "uuid": "string"
}, - "status": "ok"
}
removeUserFromGroup
Remove a user from a group
path Parameters
groupUuid required | string the UUID for the group to remove the user from |
userUuid required | string the UUID for the user to remove from the group |
Responses
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
getGroupMembers
View members of a group
path Parameters
groupUuid required | string the UUID for the group to view the members of |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "lastName": "string",
- "firstName": "string",
- "email": "string",
- "userUuid": "dcbf2986-7a6c-4291-9074-6441a23e4826"
}
], - "status": "ok"
}
getPinnedItems
Get pinned items
path Parameters
projectUuid required | string project uuid |
pinnedListUuid required | string the list uuid for the pinned items |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "data": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}, - "type": "dashboard"
}
], - "status": "ok"
}
updatePinnedItemsOrder
Update pinned items order
path Parameters
projectUuid required | string project uuid |
pinnedListUuid required | string the list uuid for the pinned items |
Request Body schema: application/json
the new order of the pinned items
required | object (Pick_ResourceViewItem-at-data.uuid-or-pinnedListOrder_) From T, pick a set of properties whose keys are in the union K |
type required | string (ResourceViewItemType) Enum: "chart" "dashboard" "space" |
Responses
Request samples
- Payload
[- {
- "data": {
- "uuid": "string",
- "pinnedListOrder": 0
}, - "type": "chart"
}
]
Response samples
- 200
- default
{- "results": [
- {
- "data": {
- "name": "string",
- "uuid": "string",
- "description": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "spaceUuid": "string",
- "views": 0,
- "firstViewedAt": "2019-08-24T14:15:22Z",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "validationErrors": [
- {
- "validationId": 0,
- "createdAt": "2019-08-24T14:15:22Z",
- "error": "string"
}
]
}, - "type": "dashboard"
}
], - "status": "ok"
}
postRunUnderlyingDataQuery
Run a query for underlying data results
path Parameters
projectUuid required | string The uuid of the project |
exploreId required | string table name |
Request Body schema: application/json
metricQuery for the chart to run
csvLimit | number <double> |
Array of objects (AdditionalMetric) | |
required | Array of objects (TableCalculation) |
limit required | number <double> |
required | Array of objects (SortField) |
required | object |
metrics required | Array of strings (FieldId) |
dimensions required | Array of strings (FieldId) |
Responses
Request samples
- Payload
{- "csvLimit": 0,
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "string",
- "table": "string",
- "name": "string",
- "index": 0
}
], - "tableCalculations": [
- {
- "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "metrics": null,
- "dimensions": null
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "metricQuery": {
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "string",
- "table": "string",
- "name": "string",
- "index": 0
}
], - "tableCalculations": [
- {
- "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "metrics": {
- "or": [
- null
], - "id": "string"
}, - "dimensions": {
- "or": [
- null
], - "id": "string"
}
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
}, - "status": "ok"
}
postRunQuery
Run a query for explore
path Parameters
projectUuid required | string The uuid of the project |
exploreId required | string table name |
Request Body schema: application/json
metricQuery for the chart to run
csvLimit | number <double> |
Array of objects (AdditionalMetric) | |
required | Array of objects (TableCalculation) |
limit required | number <double> |
required | Array of objects (SortField) |
required | object |
metrics required | Array of strings (FieldId) |
dimensions required | Array of strings (FieldId) |
Responses
Request samples
- Payload
{- "csvLimit": 0,
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "string",
- "table": "string",
- "name": "string",
- "index": 0
}
], - "tableCalculations": [
- {
- "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "metrics": null,
- "dimensions": null
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "metricQuery": {
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "string",
- "table": "string",
- "name": "string",
- "index": 0
}
], - "tableCalculations": [
- {
- "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "metrics": {
- "or": [
- null
], - "id": "string"
}, - "dimensions": {
- "or": [
- null
], - "id": "string"
}
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
}, - "status": "ok"
}
postChartResults
Run a query for a chart
path Parameters
chartUuid required | string chartUuid for the chart to run |
Request Body schema: application/json
object (Filters) | |||||
|
Responses
Request samples
- Payload
{- "filters": {
- "metrics": {
- "or": [
- null
], - "id": "string"
}, - "dimensions": {
- "or": [
- null
], - "id": "string"
}
}
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "metricQuery": {
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "string",
- "table": "string",
- "name": "string",
- "index": 0
}
], - "tableCalculations": [
- {
- "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "metrics": {
- "or": [
- null
], - "id": "string"
}, - "dimensions": {
- "or": [
- null
], - "id": "string"
}
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
}, - "status": "ok"
}
Response samples
- 200
- default
{- "results": {
- "logs": [
- {
- "details": { },
- "targetType": "email",
- "target": "string",
- "status": "scheduled",
- "createdAt": "2019-08-24T14:15:22Z",
- "scheduledTime": "2019-08-24T14:15:22Z",
- "jobGroup": "string",
- "jobId": "string",
- "schedulerUuid": "string",
- "task": "handleScheduledDelivery"
}
], - "dashboards": [
- {
- "dashboardUuid": "string",
- "name": "string"
}
], - "charts": [
- {
- "savedChartUuid": "string",
- "name": "string"
}
], - "users": [
- {
- "userUuid": "string",
- "lastName": "string",
- "firstName": "string"
}
], - "schedulers": [
- {
- "options": {
- "limit": 0,
- "formatted": true
}, - "dashboardUuid": null,
- "savedChartUuid": "string",
- "cron": "string",
- "format": "csv",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "schedulerUuid": "string",
- "targets": [
- {
- "channel": "string",
- "schedulerUuid": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "schedulerSlackTargetUuid": "string"
}
]
}
]
}, - "status": "ok"
}
getScheduler
Get a scheduler
path Parameters
schedulerUuid required | string The uuid of the scheduler to update |
Responses
Response samples
- 200
- default
{- "results": {
- "options": {
- "limit": 0,
- "formatted": true
}, - "dashboardUuid": null,
- "savedChartUuid": "string",
- "cron": "string",
- "format": "csv",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "schedulerUuid": "string",
- "targets": [
- {
- "channel": "string",
- "schedulerUuid": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "schedulerSlackTargetUuid": "string"
}
]
}, - "status": "ok"
}
updateScheduler
Update a scheduler
path Parameters
schedulerUuid required | string The uuid of the scheduler to update |
Request Body schema: application/json
the new scheduler data
the new scheduler data
Responses
Request samples
- Payload
null
Response samples
- 201
- default
{- "results": {
- "options": {
- "limit": 0,
- "formatted": true
}, - "dashboardUuid": null,
- "savedChartUuid": "string",
- "cron": "string",
- "format": "csv",
- "createdBy": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "name": "string",
- "schedulerUuid": "string",
- "targets": [
- {
- "channel": "string",
- "schedulerUuid": "string",
- "updatedAt": "2019-08-24T14:15:22Z",
- "createdAt": "2019-08-24T14:15:22Z",
- "schedulerSlackTargetUuid": "string"
}
]
}, - "status": "ok"
}