Skip to main content
POST
Create queries

Headers

x-project-id
string
required

Project ID to specify the project context

Body

application/json
queries
object[]
required

List of queries to create in a single batch. Must contain at least one query, and each item is validated against the CreateQueryDto schema.

Example:

Response

id
string<uuid>
required

Unique identifier (UUID) of the query.

Example:

"a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"

project
object
required

The project this query belongs to

Example:

"a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6"

tags
object
required

The tags IDs this query belongs to

Example:
query
string
required

The search query text tracked for this entry.

Example:

"mentionlab"

language
string
required

ISO 639-1 language code used to scope the query results.

Example:

"en"

country
string
required

ISO 3166-1 alpha-2 country code used to scope the query results.

Example:

"US"

updatedAt
string<date-time>
required

Timestamp of the last time the query was updated.

Example:

"2023-08-22T10:00:00.000Z"

type
enum<string> | null

The type of question the query asks. Null for queries that have not been classified.

Available options:
comparative,
informative,
perception
recurrenceSetting
object | null

The recurrence setting this query is linked to, or null when the query does not recur.