OverviewPlatformsAPI Reference
Analytics

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.

GET
/v1/analytics/series

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
bucket?string

The size of each point. hour for periods up to 14 days, day, week (starting Monday) or month. By default days up to 90 days and weeks beyond.

Value in

  • "hour"
  • "day"
  • "week"
  • "month"
by?string

Splits the data into a series for each platform, each keyword or each sentiment (positive, neutral, negative, unclassified). By keyword you get the top 20 by matches, with the rest combined as "other". Leave it out for one total series.

Value in

  • "platform"
  • "keyword"
  • "sentiment"

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v1/analytics/series"
{  "window": {    "from": "string",    "to": "string",    "days": 0,    "timezone": "string",    "bucket": "hour"  },  "data": [    {      "key": "string",      "label": "string",      "keyword": {        "id": "string",        "term": "string",        "kind": "brand",        "group": {          "id": "string",          "name": "string",          "externalId": "string",          "isDefault": true        }      },      "points": [        {          "date": "string",          "matched": 0,          "relevant": 0,          "positive": 0,          "neutral": 0,          "negative": 0,          "unclassified": 0        }      ]    }  ],  "previous": [    {      "key": "string",      "label": "string",      "keyword": {        "id": "string",        "term": "string",        "kind": "brand",        "group": {          "id": "string",          "name": "string",          "externalId": "string",          "isDefault": true        }      },      "points": [        {          "date": "string",          "matched": 0,          "relevant": 0,          "positive": 0,          "neutral": 0,          "negative": 0,          "unclassified": 0        }      ]    }  ]}
Was this page helpful?

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