Analytics

Get a mention breakdown

by sets the rows (platform, keyword, sentiment, intent, status, hour as weekday and hour, or person), and each row has matched, relevant and sentiment counts. 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/breakdown

Request

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

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

How to group the rows. platform, keyword, sentiment (unclassified included), intent (a mention can have several), status (open, ignored, done), hour (weekday and hour in timezone), person (the author, without anonymous posts) or language (ISO 639-1, or "unknown" when there is none).

Response

The rows, the one with the most matches first

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

Grouping used for the rows.

Changes

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