Get Entity Metrics

get

https://api.workduo.ai/data/v1/metrics/entities/{entityId}

Retrieves daily metrics for a specific entity (e.g., primary, competitor). Data can be aggregated by query, topic, or platform. Supports filtering by date range (up to 1 month), region, and platform. Also supports pagination and sorting.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

entityId

string

required

Defaults to primary

The ID of the entity to retrieve metrics for. This is a unique identifier for an entity. Use the special keyword 'primary' to retrieve metrics for the project's primary entity.

Query Params

projectId

string

required

The ID of the Project to retrieve metrics for.

dimension

string

enum

The dimension to group the metrics by. If not provided, returns metrics aggregated by date.

Allowed:

interval

string

enum

Defaults to daily

The time interval for aggregation. 'daily' returns metrics for each day in the date range. 'selectedDateRange' returns a single aggregated metric for the entire date range.

Allowed:

region

string

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

platforms

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

queryMetadata

string

Filters queries by metadata key-value pairs. Format: '{"key1": ["value1", "value2"], "key2": ["value3"]}'

dateRange

string

enum

required

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

Allowed:

startDate

date-time

Start date for custom date range (YYYY-MM-DDTHH:mm:ssZ). Required if dateRange is 'custom'.

endDate

date-time

End date for custom date range (YYYY-MM-DDTHH:mm:ssZ). Required if dateRange is 'custom'.

pageSize

integer

1 to 500

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.

Response

200Successful response