Skip to main content
GET
Get a query

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

queryId
string<uuid>
required

Id of the query

projectId
string<uuid>
required

Response

id
string<uuid>
required

Id of the query, as used on every per-query route

query
string
required

The query text sent to the engines, exactly as it is run

Example:

"best running shoes"

language
string
required

Language the query is written in, as a language code of the reference locales

Example:

"en"

country
string
required

Market the query is run for, as a country code of the reference locales

Example:

"US"

type
enum<string> | null
required

How the query is classified; null when it is not

Available options:
comparative,
informative,
perception
tags
object[]
required

Tags linked to the query; empty when it carries none

recurrenceSetting
object | null
required

The schedule that runs it, if any

updatedAt
string<date-time>
required

When the query or its tags last changed, as an ISO 8601 instant in UTC