Lightdash API (0.885.1)
Open API documentation for all public Lightdash API endpoints
Response samples
- 200
- default
{- "results": {
- "userUuid": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "organizationUuid": "string",
- "organizationName": "string",
- "organizationCreatedAt": "2019-08-24T14:15:22Z",
- "isTrackingAnonymized": true,
- "isMarketingOptedIn": true,
- "isSetupComplete": true,
- "role": "member",
- "isActive": true
}, - "status": "ok"
}
RegisterUser
Register user
Request Body schema: application/json
password required | string |
lastName required | string |
firstName required | string |
inviteCode required | string |
Responses
Request samples
- Payload
{- "password": "string",
- "lastName": "string",
- "firstName": "string",
- "inviteCode": "string"
}
Response samples
- 200
- default
{- "results": {
- "userUuid": "string",
- "email": "string",
- "firstName": "string",
- "lastName": "string",
- "organizationUuid": "string",
- "organizationName": "string",
- "organizationCreatedAt": "2019-08-24T14:15:22Z",
- "isTrackingAnonymized": true,
- "isMarketingOptedIn": true,
- "isSetupComplete": true,
- "role": "member",
- "isActive": true
}, - "status": "ok"
}
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.
Response samples
- 200
- default
{- "results": {
- "defaultProjectUuid": "string",
- "needsProject": true,
- "chartColors": [
- "string"
], - "name": "string",
- "organizationUuid": "bc554ded-7e40-44a7-b397-48480793ad03"
}, - "status": "ok"
}
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 |
defaultProjectUuid | string The project a user sees when they first log in to the organization |
Responses
Request samples
- Payload
{- "name": "string",
- "chartColors": [
- "string"
], - "defaultProjectUuid": "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"
}
GetOrganizationMemberByUuid
Get the member profile for a user in the current user's organization by uuid
path Parameters
userUuid required | string <uuid> (UUID) [0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}... the uuid of the user |
Responses
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 required | 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"
}
ListOrganizationEmailDomains
Gets the allowed email domains for the current user's organization
Responses
Response samples
- 200
- default
{- "results": {
- "projects": [
- {
- "role": "editor",
- "projectUuid": "string"
}
], - "role": "editor",
- "emailDomains": [
- "string"
], - "organizationUuid": "string"
}, - "status": "ok"
}
UpdateOrganizationEmailDomains
Updates the allowed email domains for the current user's organization
Request Body schema: application/json
the new allowed email domains
emailDomains required | Array of strings |
required | OrganizationMemberRole.EDITOR (string) or OrganizationMemberRole.INTERACTIVE_VIEWER (string) or OrganizationMemberRole.VIEWER (string) or OrganizationMemberRole.MEMBER (string) (AllowedEmailDomainsRole) |
required | Array of objects |
Responses
Request samples
- Payload
{- "emailDomains": [
- "string"
], - "role": "editor",
- "projects": [
- {
- "role": "editor",
- "projectUuid": "string"
}
]
}
Response samples
- 200
- default
{- "results": {
- "projects": [
- {
- "role": "editor",
- "projectUuid": "string"
}
], - "role": "editor",
- "emailDomains": [
- "string"
], - "organizationUuid": "string"
}, - "status": "ok"
}
CreateGroupInOrganization
Creates a new group in the current user's organization
Request Body schema: application/json
the new group details
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.
Response samples
- 200
- default
{- "results": {
- "dbtVersion": "v1.4",
- "copiedFromProjectUuid": "string",
- "pinnedListUuid": "string",
- "warehouseConnection": {
- "role": "string",
- "type": "snowflake",
- "account": "string",
- "database": "string",
- "warehouse": "string",
- "schema": "string",
- "threads": 0,
- "clientSessionKeepAlive": true,
- "queryTag": "string",
- "accessUrl": "string",
- "startOfWeek": 0
}, - "dbtConnection": {
- "type": "dbt",
- "target": "string",
- "environment": [
- {
- "value": "string",
- "key": "string"
}
], - "profiles_dir": "string",
- "project_dir": "string"
}, - "type": "DEFAULT",
- "name": "string",
- "projectUuid": "string",
- "organizationUuid": "string"
}, - "status": "ok"
}
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",
- "dashboardUuid": "string",
- "dashboardName": "string",
- "chartType": "cartesian"
}
], - "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",
- "pinnedListUuid": "string",
- "pinnedListOrder": 0,
- "isPrivate": true,
- "dashboardCount": 0,
- "chartCount": 0,
- "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"
}
GetProjectMemberAccess
Get a project explicit member's access. There may be users that have access to the project via their organization membership.
NOTE: We don't use the API on the frontend. Instead, we can call the API so that we make sure of the user's access to the project.
path Parameters
projectUuid required | string |
userUuid required | string |
Responses
Response samples
- 200
- default
{- "results": {
- "lastName": "string",
- "firstName": "string",
- "email": "string",
- "role": "viewer",
- "projectUuid": "string",
- "userUuid": "string"
}, - "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"
}
RunSqlQuery
Run a raw sql query against the project's warehouse connection
path Parameters
projectUuid required | string The uuid of the project to run the query against |
Request Body schema: application/json
The query to run
sql required | string |
Responses
Request samples
- Payload
{- "sql": "string"
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- { }
], - "fields": { }
}, - "status": "ok"
}
CalculateTotalFromQuery
Calculate all metric totals from a metricQuery
path Parameters
projectUuid required | string The uuid of the project to get charts for |
Request Body schema: application/json
The metric query to calculate totals for
explore required | string |
required | object (MetricQueryRequest) |
Responses
Request samples
- Payload
{- "explore": "string",
- "metricQuery": {
- "metadata": {
- "hasADateDimension": {
- "name": "string",
- "label": "string"
}
}, - "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "csvLimit": 0,
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "tableCalculations": null,
- "metrics": null,
- "dimensions": null
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
}
Response samples
- 200
- default
{- "results": { },
- "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 |
Request Body schema: application/json
the compiled explores to validate against an existing project, this is used in the CLI to validate a project without creating a preview
explores | Array of any |
Responses
Request samples
- Payload
{- "explores": [
- null
]
}
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 |
jobId | string optional jobId to get results for a specific job, used on CLI |
Responses
Response samples
- 200
- default
{- "results": [
- {
- "source": "chart",
- "spaceUuid": "string",
- "projectUuid": "string",
- "errorType": "chart",
- "error": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "validationId": 0,
- "chartName": "string",
- "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
Array of objects (Pick_SpaceShare.userUuid_) | |
isPrivate | boolean |
name required | string |
Responses
Request samples
- Payload
{- "access": [
- {
- "userUuid": "string"
}
], - "isPrivate": true,
- "name": "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
isPrivate required | boolean |
name required | string |
Responses
Request samples
- Payload
{- "isPrivate": true,
- "name": "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"
}
RevokeSpaceAccessForUser
Remove a user's access to a space
path Parameters
projectUuid required | string The uuid of the space's parent project |
spaceUuid required | string The uuid of the space to update |
userUuid required | string The uuid of the user to revoke access from |
Responses
Response samples
- 200
- default
{- "results": null,
- "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 required | 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
Array of objects (Pick_SpaceShare.userUuid_) | |
isPrivate | boolean |
name required | string |
Responses
Request samples
- Payload
{- "access": [
- {
- "userUuid": "string"
}
], - "isPrivate": true,
- "name": "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"
}
GetProjectMemberAccess
Get a project explicit member's access. There may be users that have access to the project via their organization membership.
NOTE: We don't use the API on the frontend. Instead, we can call the API so that we make sure of the user's access to the project.
path Parameters
projectUuid required | string |
userUuid required | string |
Responses
Response samples
- 200
- default
{- "results": {
- "lastName": "string",
- "firstName": "string",
- "email": "string",
- "role": "viewer",
- "projectUuid": "string",
- "userUuid": "string"
}, - "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
isPrivate required | boolean |
name required | string |
Responses
Request samples
- Payload
{- "isPrivate": true,
- "name": "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"
}
RevokeSpaceAccessForUser
Remove a user's access to a space
path Parameters
projectUuid required | string The uuid of the space's parent project |
spaceUuid required | string The uuid of the space to update |
userUuid required | string The uuid of the user to revoke access from |
Responses
Response samples
- 200
- default
{- "results": null,
- "status": "ok"
}
uploadGsheet
Upload results from query to Google Sheet
Request Body schema: application/json
hiddenFields | Array of strings |
customLabels | object (CustomLabel) |
columnOrder required | Array of strings |
showTableNames required | boolean |
required | object (MetricQueryResponse) |
exploreId required | string |
projectUuid required | string |
Responses
Request samples
- Payload
{- "hiddenFields": [
- "string"
], - "customLabels": {
- "property1": "string",
- "property2": "string"
}, - "columnOrder": [
- "string"
], - "showTableNames": true,
- "metricQuery": {
- "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "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"
]
}, - "exploreId": "string",
- "projectUuid": "string"
}
Response samples
- 200
- default
{- "results": {
- "jobId": "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"
}
GetDbtSemanticLayerData
Get DbtSemanticLayer data
path Parameters
projectUuid required | string the projectId |
Request Body schema: application/json
graphql query
operationName | string Enum: "GetFields" "CreateQuery" "GetQueryResults" |
query required | string |
Responses
Request samples
- Payload
{- "operationName": "GetFields",
- "query": "string"
}
Response samples
- 200
- default
null
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": [
- {
- "category": "mostPopular",
- "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": [
- {
- "category": "mostPopular",
- "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"
}
RunSqlQuery
Run a raw sql query against the project's warehouse connection
path Parameters
projectUuid required | string The uuid of the project to run the query against |
Request Body schema: application/json
The query to run
sql required | string |
Responses
Request samples
- Payload
{- "sql": "string"
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- { }
], - "fields": { }
}, - "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
object | |
Array of objects (CustomDimension) | |
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
{- "metadata": {
- "hasADateDimension": {
- "name": "string",
- "label": "string"
}
}, - "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "csvLimit": 0,
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "tableCalculations": null,
- "metrics": null,
- "dimensions": null
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "cacheMetadata": {
- "cacheHit": true,
- "cacheUpdatedTime": "2019-08-24T14:15:22Z"
}, - "metricQuery": {
- "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "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"
}
RunMetricQuery
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
object | |
Array of objects (CustomDimension) | |
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
{- "metadata": {
- "hasADateDimension": {
- "name": "string",
- "label": "string"
}
}, - "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "csvLimit": 0,
- "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "tableCalculations": null,
- "metrics": null,
- "dimensions": null
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "cacheMetadata": {
- "cacheHit": true,
- "cacheUpdatedTime": "2019-08-24T14:15:22Z"
}, - "metricQuery": {
- "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "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
invalidateCache | boolean |
Responses
Request samples
- Payload
{- "invalidateCache": true
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "cacheMetadata": {
- "cacheHit": true,
- "cacheUpdatedTime": "2019-08-24T14:15:22Z"
}, - "metricQuery": {
- "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "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
path Parameters
chartUuid required | string |
Request Body schema: application/json
granularity | string (DateGranularity) Enum: "Day" "Week" "Month" "Quarter" "Year" |
dashboardUuid required | string |
required | Array of objects (SortField) |
invalidateCache | boolean |
dashboardFilters required | any |
Responses
Request samples
- Payload
{- "granularity": "Day",
- "dashboardUuid": "string",
- "dashboardSorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "invalidateCache": true,
- "dashboardFilters": null
}
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "cacheMetadata": {
- "cacheHit": true,
- "cacheUpdatedTime": "2019-08-24T14:15:22Z"
}, - "metricQuery": {
- "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "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"
}
get
Get chart version history from last 30 days
path Parameters
chartUuid required | string chartUuid for the chart |
Responses
Response samples
- 200
- default
{- "results": {
- "history": [
- {
- "createdAt": "2019-08-24T14:15:22Z",
- "chartUuid": "string",
- "versionUuid": "string",
- "createdBy": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}
}
]
}, - "status": "ok"
}
get
Get chart version
path Parameters
chartUuid required | string chartUuid for the chart |
versionUuid required | string versionUuid for the chart version |
Responses
Response samples
- 200
- default
{- "results": {
- "chart": {
- "dashboardName": "string",
- "dashboardUuid": "string",
- "pinnedListOrder": 0,
- "pinnedListUuid": "string",
- "spaceName": "string",
- "spaceUuid": "string",
- "organizationUuid": "string",
- "updatedByUser": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "updatedAt": "2019-08-24T14:15:22Z",
- "tableConfig": {
- "columnOrder": [
- "string"
]
}, - "chartConfig": {
- "config": {
- "comparisonLabel": "string",
- "flipColors": true,
- "comparisonFormat": "raw",
- "showComparison": true,
- "showBigNumberLabel": true,
- "selectedField": "string",
- "style": "thousands",
- "label": "string"
}, - "type": "big_number"
}, - "pivotConfig": {
- "columns": [
- "string"
]
}, - "metricQuery": {
- "metadata": {
- "hasADateDimension": {
- "name": "string",
- "label": "string"
}
}, - "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "sql": "string",
- "displayName": "string",
- "name": "string",
- "index": 0
}
], - "limit": 0,
- "sorts": [
- {
- "descending": true,
- "fieldId": "string"
}
], - "filters": {
- "tableCalculations": {
- "or": [
- null
], - "id": "string"
}, - "metrics": {
- "or": [
- null
], - "id": "string"
}, - "dimensions": {
- "or": [
- null
], - "id": "string"
}
}, - "metrics": [
- "string"
], - "dimensions": [
- "string"
]
}, - "tableName": "string",
- "description": "string",
- "name": "string",
- "projectUuid": "string",
- "uuid": "string"
}, - "createdBy": {
- "userUuid": "string",
- "firstName": "string",
- "lastName": "string"
}, - "createdAt": "2019-08-24T14:15:22Z",
- "versionUuid": "string",
- "chartUuid": "string"
}, - "status": "ok"
}
getChartVersionResults
Run a query for a chart version
path Parameters
chartUuid required | string chartUuid for the chart to run |
versionUuid required | string versionUuid for the chart version |
Responses
Response samples
- 200
- default
{- "results": {
- "rows": [
- null
], - "cacheMetadata": {
- "cacheHit": true,
- "cacheUpdatedTime": "2019-08-24T14:15:22Z"
}, - "metricQuery": {
- "customDimensions": [
- {
- "id": "string",
- "name": "string",
- "dimensionId": "string",
- "table": "string",
- "binType": "fixed_number",
- "binNumber": 0,
- "binWidth": 0,
- "customRange": [
- {
- "to": 0,
- "from": 0
}
]
}
], - "additionalMetrics": [
- {
- "label": "string",
- "type": "percentile",
- "description": "string",
- "sql": "string",
- "hidden": true,
- "round": 0,
- "compact": "thousands",
- "format": "km",
- "table": "string",
- "name": "string",
- "index": 0,
- "filters": [
- {
- "values": [
- null
], - "operator": "isNull",
- "id": "string",
- "target": {
- "fieldRef": "string"
}, - "settings": null,
- "disabled": true
}
], - "baseDimensionName": "string",
- "uuid": "string",
- "percentile": 0
}
], - "tableCalculations": [
- {
- "format": {
- "suffix": "string",
- "prefix": "string",
- "compact": "thousands",
- "currency": "string",
- "separator": "default",
- "round": 0,
- "type": "default"
}, - "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"
}
CalculateTotalFromSavedChart
Calculate metric totals from a saved chart
path Parameters
chartUuid required | string chartUuid for the chart to run |
Request Body schema: application/json
invalidateCache | boolean |
dashboardFilters | any |
Responses
Request samples
- Payload
{- "invalidateCache": true,
- "dashboardFilters": null
}
Response samples
- 200
- default
{- "results": { },
- "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",
- "message": "string",
- "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",
- "message": "string",
- "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",
- "message": "string",
- "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"
}
Response samples
- 200
- default
{- "results": [
- {
- "attributeDefault": "string",
- "users": [
- {
- "value": "string",
- "email": "string",
- "userUuid": "string"
}
], - "description": "string",
- "organizationUuid": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "uuid": "string"
}
], - "status": "ok"
}
createUserAttribute
Creates new user attribute
Request Body schema: application/json
the user attribute to create
name required | string |
description | string |
attributeDefault required | string or null |
required | Array of objects (CreateUserAttributeValue) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "attributeDefault": "string",
- "users": [
- {
- "userUuid": "string",
- "value": "string"
}
]
}
Response samples
- 200
- default
{- "results": {
- "attributeDefault": "string",
- "users": [
- {
- "value": "string",
- "email": "string",
- "userUuid": "string"
}
], - "description": "string",
- "organizationUuid": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "uuid": "string"
}, - "status": "ok"
}
updateUserAttribute
Updates a user attribute
path Parameters
userAttributeUuid required | string the UUID for the group to add the user to |
Request Body schema: application/json
the user attribute to update
name required | string |
description | string |
attributeDefault required | string or null |
required | Array of objects (CreateUserAttributeValue) |
Responses
Request samples
- Payload
{- "name": "string",
- "description": "string",
- "attributeDefault": "string",
- "users": [
- {
- "userUuid": "string",
- "value": "string"
}
]
}
Response samples
- 200
- default
{- "results": {
- "attributeDefault": "string",
- "users": [
- {
- "value": "string",
- "email": "string",
- "userUuid": "string"
}
], - "description": "string",
- "organizationUuid": "string",
- "name": "string",
- "createdAt": "2019-08-24T14:15:22Z",
- "uuid": "string"
}, - "status": "ok"
}