GET
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
query-patterns
List generated query patterns reports
curl --request GET \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns \
  --header 'Authorization: <api-key>'
{
  "has_next": true,
  "has_prev": true,
  "cursor_start": "<string>",
  "cursor_end": "<string>",
  "data": [
    {}
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
organization
string
required

The name of the organization the branch belongs to

​
database
string
required

The name of the database the branch belongs to

​
branch
string
required

The name of the branch

Response

Returns the generated query patterns reports

​
has_next
boolean
required

Whether there is a next page of results

​
has_prev
boolean
required

Whether there is a previous page of results

​
cursor_start
string
required

The ID of the first object in the current results

​
cursor_end
string
required

The ID of the last object in the current results

​
data
object[]
required