OverviewPlatformsAPI Reference
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

Authorization

bearerAuth
AuthorizationBearer <token>

An API key from POST /v1/api-keys. Keys start with ref_.

In: header

Query Parameters

range?string

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

Value in

  • "7d"
  • "30d"
  • "90d"
  • "365d"
from?string

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

Match^\d{4}-\d{2}-\d{2}$
to?string

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

Match^\d{4}-\d{2}-\d{2}$
keywordIds?array<>|

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

Itemsitems <= 50
platforms?array<>

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

Itemsitems <= 20
compare?boolean

true adds the equally long period just before as previous.

timezone?string

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.

Lengthlength <= 64
by*string

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).

Value in

  • "platform"
  • "keyword"
  • "sentiment"
  • "intent"
  • "status"
  • "hour"
  • "person"
  • "language"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics/breakdown?by=platform"
{  "window": {    "from": "string",    "to": "string",    "days": 0,    "timezone": "string"  },  "by": "platform",  "data": [    {      "key": "string",      "label": "string",      "keyword": {        "id": "string",        "term": "string",        "kind": "brand",        "group": {          "id": "string",          "name": "string",          "externalId": "string",          "isDefault": true        }      },      "person": {        "id": "string",        "name": "string",        "platform": "bluesky",        "url": "string",        "avatarUrl": "string",        "followers": 0      },      "slot": {        "weekday": 0,        "hour": 0      },      "matched": 0,      "relevant": 0,      "share": 0,      "sentiment": {        "positive": 0,        "neutral": 0,        "negative": 0,        "unclassified": 0      },      "previous": {        "matched": 0,        "relevant": 0      }    }  ]}
Was this page helpful?

Update a channel

Changes a channel's label and account events, and a webhook's URL and headers. `headers` and `events` replace the old values.

Mentions over time

Returns matched, relevant and sentiment counts per day or week over the period. You get one total series, or one per platform or keyword with `by`. 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.