Analytics

Headline counts for a window

Matched and relevant mentions, distinct posts and people, sentiment, buying intent and questions, estimated reach, and where the matches stand in triage. 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/summary

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/analytics/summary
  • 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.

Response

The counts, with previous when comparing

matchedinteger required

Every match in the window, relevant or not: the number usage counts.

relevantinteger required

Matches scored at or above the relevance threshold.

postsinteger required

Distinct posts behind the matches: a post matching two keywords is two matches, one post.

peopleinteger required

Distinct authors behind the matches.

buyIntentinteger required

Matches carrying the buy_intent intent.

questionsinteger required

Matches carrying the question intent.

Changes

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