API

Get Responses

get
https://api.workduo.ai/core/v1/responses

Retrieves raw AI-generated response data with associated metrics (Visibility, Share of Voice, Position) and citations for a specified Project. Supports filtering by platform (e.g., ChatGPT, DeepSeek), date range up to 1 month, optional region, query ID, and topic ID filtering, pagination, and sorting by multiple fields. If both query_id and topic_id are provided, query_id takes precedence.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

The ID of the Project to retrieve responses for (e.g., project tracking Acme Limited).

string
enum
required

The date range for the data. Use 'custom' for specific dates.

Allowed:
date

Start date for custom date range (YYYY-MM-DD). Required if dateRange is 'custom'.

date

End date for custom date range (YYYY-MM-DD). Required if dateRange is 'custom'.

string

The region code to filter data (e.g., 'US' for United States). If not provided, returns data for all regions.

string

The platform to filter data (e.g., 'openai:chatgpt' for ChatGPT). If not provided, returns data for all platforms. Supports multiple values with comma-separated values e.g. "openai:chatgpt,google:ai-overview".

string

The ID of the query to filter responses. If provided, takes precedence over topicId. If not provided, returns responses for all queries.

integer
1 to 100
Defaults to 10

The number of records to return per page. Defaults to 10.

string

A token identifying the starting point for the next page of results. Use an empty string for the first page.

string

Fields to filter query, as a JSON object (e.g., '{"key-1": ["val-1-1", "val-1-2"], "key-2": ["val-2-1"]}')

Responses

Updated 11 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 months ago

Did this page help you?