Analytics

Get summary counts

Returns matched and relevant mentions, unique posts and people, sentiment, buying intent and questions, estimated reach, and the triage status of the matches. Pick the period with range (7d, 30d, 90d or 365d up to today) or with from and to. Days follow timezone, UTC by default. keywordIds and platforms narrow the data, and compare=true adds the equally long period just before. Dates are publish dates.

get/v1/analytics/summary

Request

  • Base URL: https://api.rumoro.dev
  • URL: https://api.rumoro.dev/v1/analytics/summary
  • Auth: HTTP bearer

Query parameters

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

A preset period up to today, 30d by default. Ignored when you send from or to.

fromstring

Start date in timezone, as YYYY-MM-DD. That day is included.

tostring

End date in timezone, as YYYY-MM-DD, included. Defaults to today.

keywordIdsstring[] nullable

Keeps these keyword ids only. Repeat the parameter or separate values with commas. Leave it out for all keywords.

platformsstring[]

Keeps these platforms only. Repeat the parameter or separate values with commas. Leave it out for all platforms.

compareboolean

true adds the equally long period just before as previous.

timezonestring

The IANA time zone used to split days, such as America/New_York. Defaults to UTC. The zone's offset at the end of the period is used for the whole period.

Response

The counts, plus previous with compare=true

matchedinteger required

All matches in the window, relevant or not. Usage counts this number.

relevantinteger required

Matches whose relevance score reached the threshold.

postsinteger required

Unique posts among the matches. A post that matches two keywords counts as two matches but one post.

peopleinteger required

Unique authors among the matches.

buyIntentinteger required

Matches tagged buy_intent.

questionsinteger required

Matches tagged question.

Changes

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