API docs by Redocly

Download OpenAPI specification:

API

mentions

Returns a list of mentions for a stream

Authorizations:
api_key
path Parameters
streamId
required
integer

The stream to search on

query Parameters
filter[range][after]
required
string <date-time>

The beginning of the date range to search

filter[range][before]
required
string <date-time>

The end of the date range to search

pagination[page]
required
integer
Default: 1

The page of the results to return

pagination[page_size]
required
integer <= 5000
Default: 10

The number of results to return per page. The combined value of page and page_size cannot exceed the maximum results of 5000 mentions

sort[field]
string
Enum: "published_at" "timestamp" "created_at"

The field to sort by

sort[order]
string
Enum: "asc" "desc"

The order to sort by

format
required
string
Enum: "json" "csv"

JSON or CSV

header Parameters
X-Auth-Token
required
string

The API Token

Responses

Response samples

Content type
{
  • "id": 1233,
  • "type": "onlineArticle",
  • "timestamp": 1722470400194,
  • "createdAt": "2024-08-02T02:08:26.000Z",
  • "publishedAt": "2024-08-02T02:08:26.000Z",
  • "medium": "Online",
  • "title": "A particularly interesting article title",
  • "author": "Article Author",
  • "url": "https://example.com/articles/foo.html",
  • "internalLink": "https://items.cision.one/ASDASDASDASD",
  • "source": "Sydney Morning Herald",
  • "timeZone": "Australia/Sydney",
  • "locationCountry": "Australia",
  • "locationState": "New South Wales",
  • "locationCity": "Sydney",
  • "languageCode": "en-AU",
  • "sentiment": -0.1,
  • "keywords": [
    ],
  • "wordCount": 2493,
  • "audience": 250000,
  • "advertisingValue": 100,
  • "impactScore": [
    ]
}

stream

Returns an organisation's Streams

Multiple status values can be provided with comma separated strings

Authorizations:
api_key
query Parameters
format
string
Enum: "json" "csv"

JSON or CSV

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get a statistics summary for a stream

Returns a statistics summary for a stream.

Authorizations:
api_key
path Parameters
streamId
required
integer

The stream to search on

query Parameters
filter[range][after]
required
string

The beginning of the date range to search

filter[range][before]
required
string <date-time>

The end of the date range to search

format
required
string
Enum: "json" "csv"

JSON or CSV

header Parameters
X-Auth-Token
required
string

The API Token

Responses

Response samples

Content type
{
  • "streamId": 3349,
  • "streamLabel": "The Daily Show",
  • "before": "2023-06-14T02:34:56.000Z",
  • "after": "2023-06-14T02:34:56.000Z",
  • "media": [
    ],
  • "advertisingValues": [
    ],
  • "audiencesByType": [
    ],
  • "sentimentAggregation": [
    ]
}