v17

latestOpenAPI 3.0.1raw.githubusercontent.com2026-07-08165682.0 MB
Query Insights reports

Show the status of a query patterns report

Authorization

A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:

Service Token Accesses read_branch

OAuth Scopes

ResourceScopes
Organizationread_branches
Databaseread_branches
Branchread_branch
get/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}

Path parameters

organizationstring required

The name of the organization the branch belongs to

databasestring required

The name of the database the branch belongs to

branchstring required

The name of the branch

idstring required

The ID of the query patterns report

Response

The retrieved query patterns download

idstring required

The ID of the query patterns download

state'pending' | 'completed' | 'failed' required

The state of the download

created_atstring required

When the download was created

finished_atstring nullable required

When the download was finished

urlstring required

The URL to access the query patterns download

download_urlstring required

The URL to download the query patterns file