Skip to main content
GET
List the project's queries

Headers

x-project-id
string
required

Project ID to specify the project context

Path Parameters

projectId
string<uuid>
required

Query Parameters

page
integer
default:1

Which slice of the matched rows to return, counted from 1. Rows skipped are (page - 1) * limit.

Required range: 1 <= x <= 1000000
Example:

2

limit
integer
default:25

How many rows one page holds, capped at 100 to keep a single response bounded.

Required range: 1 <= x <= 100
Example:

50

Substring of the query text, accents and apostrophes folded

Example:

"running shoes"

languages
string[]

Queries in any of these languages, as reference locale language codes

Example:
countries
string[]

Queries run for any of these markets, as country codes of the reference locales

Example:
types
enum<string>[]

Queries of any of these types; an untyped query matches none

The type of question the query asks: "comparative" (compares options), "informative" (seeks facts or how-to information) or "perception" (probes opinions about a brand).

Available options:
comparative,
informative,
perception
tagIds
number[]

Queries carrying these tags, by tag id. See tagMode

Example:
tagGroupIds
string<uuid>[]

Queries with a tag of these groups. See tagMode

Example:
tagMode
enum<string>

"and" (default): every tag, and a tag of each group. "or": any tag, or a tag of any group

Available options:
and,
or
recurrenceSettingIds
string<uuid>[]

Queries on any of these schedules

Example:
hasRecurrenceSetting
boolean

Whether a schedule runs them

Example:

true

sort
string

Comma-separated field:asc|desc pairs. Sortable: query, updatedAt.

Example:

"query:asc"

Response

page
object
required
results
object[]