ReDoc documentation

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

200

Content type

application/json

[{"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": ["foo",
"bar"
],
"wordCount": 2493,
"audience": 250000,
"advertisingValue": 100,
"impactScore": [{"score": 223.92,
"grade": "Medium"
}
],
"domainAuthority": 75,
"social": {"x": 50,
"facebook": 10,
"reddit": 3,
"pinterest": 0
}
},
{"id": 104,
"type": "radioClip",
"timestamp": 1718418776104,
"createdAt": "2025-11-27T21:16:50.000Z",
"publishedAt": "2024-06-15T12:32:56.000+10:00",
"medium": "Radio",
"author": "Test",
"url": "http://radio_clip_url6",
"internalLink": "https://items.cision.one/RA00000104",
"source": "RadioStation19",
"timeZone": "Australia/Sydney",
"locationCountry": "Australia",
"locationState": "New South Wales",
"locationCity": "Sydney",
"languageCode": "en-AU",
"sentiment": -0.1,
"keywords": ["foo",
"bar"
],
"wordCount": 2493,
"audience": 250000,
"advertisingValue": 100,
"impactScore": [{"score": 223.92,
"grade": "Medium"
}
],
"domainAuthority": 75,
"localViewershipAudience": 50000,
"nationalViewershipAudience": 100000,
"localViewershipAdValue": 250.51,
"nationalViewershipAdValue": 500.751,
"transcript": "This is the transcript of the clip."
}
]

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

200

Content type

application/json

[{"id": 3349,
"label": "The Daily Show",
"createdAt": "2023-06-14T02:34:56.000Z",
"updatedAt": "2023-06-14T02:34:56.000Z",
"queryStyle": "boolean",
"keywords": "foo",
"excludedKeywords": "bar",
"defaultSentimentRating": 0,
"archived": false,
"magazineContent": true,
"onlineContent": true,
"podcastContent": true,
"printContent": true,
"radioContent": true,
"socialContent": true,
"tvContent": true
}
]

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

200

Content type

application/json

{"streamId": 3349,
"streamLabel": "The Daily Show",
"before": "2023-06-14T02:34:56.000Z",
"after": "2023-06-14T02:34:56.000Z",
"media": ["Online",
"Print",
"TV",
"Radio"
],
"advertisingValues": [{"label": "TV",
"values": {"count": 100,
"total": 100
}
},
{"label": "Radio",
"values": {"count": 100,
"total": 100
}
}
],
"audiencesByType": [{"label": "TV",
"value": 100
},
{"label": "Radio",
"value": 100
}
],
"sentimentAggregation": [{"label": "Negative",
"values": {"from": 0,
"to": 10,
"doc_count": 100
}
},
{"label": "Trending Negative",
"values": {"from": 0,
"to": 10,
"doc_count": 100
}
},
{"label": "Balanced",
"values": {"from": 0,
"to": 20,
"doc_count": 100
}
},
{"label": "Trending Positive",
"values": {"from": 30,
"to": 40,
"doc_count": 100
}
},
{"label": "Positive",
"values": {"from": 40,
"to": 50,
"doc_count": 100
}
}
]
}