Analytics

Mentions grouped by one dimension

One table of matched, relevant and sentiment counts grouped by by: platform, keyword, sentiment, intent, status, hour (weekday and hour of day) or person. The window is range (7d, 30d, 90d, 365d, ending today) or from and to, cut into days in timezone (UTC by default); keywordIds and platforms narrow it; compare=true adds the period of the same length right before it. Time axis is the publish date.

get/v1/analytics/breakdown

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/analytics/breakdown
  • Auth: HTTP bearer

Query parameters

range'7d' | '30d' | '90d' | '365d'

Preset window ending today. Ignored when from or to is given. Default 30d.

fromstring

First day, YYYY-MM-DD, inclusive, in timezone.

tostring

Last day, YYYY-MM-DD, inclusive, in timezone. Default today.

keywordIdsstring[] nullable

Only these keyword ids. Repeatable, or comma-separated; omit for every keyword.

platformsstring[]

Only these platforms. Repeatable, or comma-separated; omit for every platform.

compareboolean

true adds the period of the same length right before the window as previous.

timezonestring

IANA zone the days are cut in (Europe/Madrid). Default UTC. One offset, the zone's at the end of the window, applies to the whole window.

by'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit' required

The dimension to group by: platform, keyword, sentiment (unclassified included), intent (a mention can carry several), status (open, ignored, done), hour (weekday and hour of day in timezone), person (who posted; anonymous posts are left out), language (ISO 639-1; "unknown" for posts without one), country (where the author is, ISO 3166-1 alpha-2; "unknown" for posts without one), subreddit (Reddit posts only, most active first; share stays a percent of the whole window, every platform included).

Response

Groups, most matched first

by'platform' | 'keyword' | 'sentiment' | 'intent' | 'status' | 'hour' | 'person' | 'language' | 'country' | 'subreddit' required

The dimension the rows are grouped by.

Changes

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