Statistics

Histogram

Mentions count, authors count, engagement, and optionally sentiment per date interval for a period. When interval is day, the requested period must be less than 3 months.

get/topics/{topicId}/statistics/histogram

Request

Base URL
https://api.youscan.io/api/external
Auth
- API key in header X-API-KEY
- or API key in query parameter apiKey
TypeScript
https://skmtc.dev/youscan/apis/youscan-api/docs/topics/:topicId/statistics/histogram/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

topicIdinteger required

ID of the Topic.

Query parameters

fromstring date

Example:2024-01-01

ISO formatted date from (yyyy-MM-dd). Filters by publication date; the day starts in the API key owner's time zone (see Dates and time zones in the Mentions section). Default - 6 days before today.

tostring date

Example:2024-12-31

ISO formatted date to (yyyy-MM-dd), inclusive. The day ends in the API key owner's time zone (see Dates and time zones in the Mentions section). Default - today.

Histogram interval.

sentimentboolean

Whether to include sentiment distribution.

countrystring[]

Filter mentions by ISO alpha-2 country codes. Multiple values are supported.

excludeCountrystring[]

Exclude mentions by ISO alpha-2 country codes. Multiple values are supported.

sourceTypesSourceTypeFilter[]

Filter mentions by source type. Multiple values are supported.

excludeSourceTypesSourceTypeFilter[]

Exclude mentions by source type. Multiple values are supported.

sourcesstring[]

Filter mentions by source. Multiple values are supported.

excludeSourcesstring[]

Exclude mentions by source. Multiple values are supported.

tagsinteger[]

Filter mentions by tag IDs. Multiple values are supported.

excludeTaginteger[]

Exclude mentions by tag IDs. Multiple values are supported.

subcategoriesinteger[]

Filter mentions by subcategory IDs. Multiple values are supported.

excludeSubcategoryinteger[]

Exclude mentions by subcategory IDs. Multiple values are supported.

Response

Histogram data.

authorsCountinteger

Total unique authors for the period.

engagementinteger

Total engagement for the period.

totalCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.