Skip to main content
POST
/
organizations
/
{organization}
/
databases
/
{database}
/
branches
/
{branch}
/
query-patterns
Create a new query patterns report
curl --request POST \
  --url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns \
  --header 'Authorization: <api-key>'
{
  "id": "<string>",
  "state": "pending",
  "created_at": "<string>",
  "finished_at": "<string>",
  "url": "<string>",
  "download_url": "<string>",
  "actor": {
    "id": "<string>",
    "display_name": "<string>",
    "avatar_url": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

organization
string
required
database
string
required
branch
string
required

Response

id
string
required
state
enum<string>
required
Available options:
pending,
completed,
failed
created_at
string
required
finished_at
string
required
url
string
required
download_url
string
required
actor
object
required