Skip to main content
POST
Get All Citations

Authorizations

X-API-KEY
string
header
required

Body

application/json

Request parameters for retrieving all citations.

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).

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:
filters
CitationFiltersInput · object

Optional filters to narrow down citations by domain, URL, or path.

Response

Successful Response

Response containing citation data.

data
CitationDataItem · object[]
required

Array of citation data items

info
ResponseInfo · object

Information of the API request including total count and query details