Get Metrics

get deprecated

https://api.workduo.ai/data/v1/metrics

Retrieves daily metrics data (Visibility, Share of Voice, Position, or All) for a specified Project, grouped by dimension (entity, query, topic, platform). Supports filtering by platform (e.g., ChatGPT, DeepSeek), date ranges up to 1 month, optional region filtering, pagination, and sorting by multiple fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

projectId

string

required

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

metric

string

enum

required

The metric to retrieve. Use 'all' to retrieve all metrics.

Allowed:

dimension

string

enum

required

The dimension to group the metrics by.

Allowed:

dateRange

string

enum

required

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

Allowed:

startDate

date

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

endDate

date

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

region

string

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

platform

string

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

pageSize

integer

1 to 100

Defaults to 10

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

pageToken

string

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

orderBy

string

Fields to sort by, as a JSON array of objects with 'name' (field) and 'value' (direction) properties (e.g., '[{"name":"visibility","value":"asc"},{"name":"sov","value":"desc"}]'). Valid names: visibility, sov, position, dimensionValue. Valid values: asc, desc. Defaults to '[{"name":"dimensionValue","value":"asc"}]'.

queryMetadata

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

200Successful response with metrics data

400Bad request (e.g., invalid projectId, region, platform, pageSize, pageToken, orderBy, or missing required parameters)

401Unauthorized (e.g., invalid API key)

404Project not found