Skip to main content
POST
Get All Prompts

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request parameters for retrieving all prompts.

project_id
string
required

Unique identifier of the project to query. Get valid project IDs from get_all_projects.

Minimum string length: 1
Example:

"550e8400-e29b-41d4-a716-446655440000"

start_date
string<date-time>

Start of the date range (ISO 8601). Limits results to data collected on or after this date. When omitted: defaults to the latest run's start date for metric queries, or earliest available date for list queries.

Examples:

"2026-01-01T00:00:00Z"

"2026-03-01T00:00:00Z"

end_date
string<date-time>

End of the date range (ISO 8601). Limits results to data collected on or before this date. When omitted: defaults to today. Date-only strings (no 'T') are extended to end of day.

Examples:

"2026-01-31T23:59:59Z"

"2026-03-17T23:59:59Z"

current_from
string<date-time>

Alias for start_date (analytics-tool date naming).

current_to
string<date-time>

Alias for end_date (analytics-tool date naming).

comparison_start_date
string<date-time>

Start of the comparison (past) date range (ISO 8601). Provide together with comparison_end_date to additionally compute every measure over this past range — each row then includes previous_ values calculated with identical dimensions, measures, and filters.

Example:

"2026-07-25T00:00:00Z"

comparison_end_date
string<date-time>

End of the comparison (past) date range (ISO 8601). Required together with comparison_start_date. Date-only strings (no 'T') are extended to end of day, same as end_date.

Example:

"2026-07-31T23:59:59Z"

previous_from
string<date-time>

Alias for comparison_start_date (analytics-tool date naming).

previous_to
string<date-time>

Alias for comparison_end_date (analytics-tool date naming).

order_by
SortingOrder · object[]

Sort results by one or more fields. Each entry specifies a field name and direction. Results are sorted by the first entry, then ties broken by subsequent entries.

Examples:
pagination
PaginationInput · object

Control result pagination. Set limit for page size and offset to skip results. Omit to return all results (use with caution on large datasets).

Examples:
metrics
enum<string>[]

Additional metrics to include. Options: answers_count, answers, answers_detailed, visibility_score, citation_share, rank, mention_count, citing_answers.

Metrics to include per prompt. Requesting any metric scopes the report to the latest run date range unless dates are given.

  • answers_count: Number of AI answers collected for the prompt
  • answers: The answers themselves (date, text, model)
  • answers_detailed: Answers plus per-answer self mention, brands mentioned, rank and inaccuracies. Large payload — page with a small limit
  • visibility_score: Percentage of answers mentioning your brand (0-100)
  • citation_share: Percentage of answers citing your domains (0-100)
  • rank: Average rank of your brand across mentioning answers (1-99; 0 when never mentioned)
  • mention_count: Number of brand mentions across answers
  • citing_answers: Number of answers citing your domains
Available options:
answers_count,
answers,
answers_detailed,
visibility_score,
citation_share,
rank,
mention_count,
citing_answers
Example:
filters
PromptFiltersInput · object

Optional filters to narrow down prompts by topics, tags, markets, etc.

Response

Successful Response

Response containing prompt report data.

data
PromptDataItem · object[]
required

Array of prompt data items

info
ResponseInfo · object

Information of the API request including total count and query details