Skip to main content

How does the CisionOne API work?

A guide to the CisionOne API

C
Written by CX Enablement
Updated over 2 weeks ago

Summary

The CisionOne API allows you to connect your Monitoring data to your other internal data sets.

The API runs off of Mention Streams that have already been created in an account. All CisionOne API calls are made under https://api.cision.one and all responses return as JSON and CSV formats.

The customer will have the option to return the following data:

  1. Returns a list of mentions for a Mention Stream

  2. A summary of stats and metrics for a Mention Stream

  3. Returns a list of the customer’s Mention Streams

How Does Cision's API Work?

We comply with our partnership and do not provide readership via API.

In order to support the widest array of business intelligence (BI) tools, we developed our API so that you can pull data from Cision into your apps. We don’t have any direct connectors for other tools with our Cision API, so the development effort to pull from the Cision API and import that data into your system of choice falls on you and your developers.

What data is provided in the API?

For a mention (Returns a list of mentions for a stream):

  1. Type

  2. CreatedAt

  3. PublishedAt

  4. Medium

  5. Title

  6. Author

  7. Removed?

  8. URL

  9. Internal Cision link

  10. Source

  11. Source TimeZone

  12. Location

  13. LanguageCode

  14. Sentiment

  15. Keywords

  16. WordCount

  17. Audience*

  18. AVE

  19. ImpactScore

*Due to our relationship with SimilarWeb, we are unable to provide individual audience data for Online content in the API.

Response Sample:

1 [

2 {

3 "id": 0,

4 "timestamp": 0,

5 "createdAt": "2019-08-24T14:15:22Z",

6 "publishedAt": "2019-08-24T14:15:22Z",

7 "medium": "string",

8 "title_summary": "string",

9 "author": "string",

10 "removed": true,

11 "url": "string",

12 "internalLink": "string",

13 "source": "string",

14 "timeZone": "string",

15 "locationCountry": "string",

16 "locationState": "string",

17 "locationCity": "string",

18 "languageCode": "string",

19 "wordCount": 0,

20 "sentiment": 0,

21 "keywordCounts": [],

22 "audience": 0,

23 "advertisingValue": 0,

24 "impactScore": 0

25 }

26 ]

27

For a Mention Stream (A statistics summary for a stream):

  1. DateRange

  2. StreamLabel

  3. MediaType

  4. AVE

  5. AudiencesByType

  6. SentimentAggregation

Response Sample:

1 {

2"streamId": 3349,

3 "streamLabel": "The Daily Show",

4 "before": "2023-06-14T02:34:56.000Z",

5 "after": "2023-06-14T02:34:56.000Z",

6 "media": [

7 "Online",

8 "Print",

9 "TV",

10 "Radio"

11 ],

12 "advertisingValues": [

13 {

14 "label": "TV",

15 "values": {

16 "count": 100,

17 "total": 100

18 }

19 },

20 {

21 "label": "Radio",

22 "values": {

23 "count": 100,

24 "total": 100

25 }

26 }

27 ],

28 "audiencesByType": [

29 {

30 "label": "TV",

31 "value": 100

32 },

33 {

34 "label": "Radio",

35 "value": 100

36 }

37 ],

38 "sentimentAggregation": [

39 {

40 "label": "Negative",

41 "values": {

42 "from": 0,

43 "to": 10,

44 "doc_count": 100

45 }

46 },

47 {

48 "label": "Trending Negative",

49 "values": {

50 "from": 0,

51 "to": 10,

52 "doc_count": 100

53 }

54 },

55 {

56 "label": "Balanced",

57 "values": {

58 "from": 0,

59 "to": 20,

60 "doc_count": 100

61 }

62 },

63 {

64 "label": "Trending Positive",

65 "values": {

66"from": 30,

67 "to": 40,

68 "doc_count": 100

69 }

70 },

71 {

72 "label": "Positive",

73 "values": {

74 "from": 40,

75 "to": 50,

76 "doc_count": 100

77 }

78 }

79 ]

80 }

81

For all Mention Streams in your account:

You can also choose to get a summary of all of the Mention Streams in your account. If you choose this, you will get the following stats and metrics relating to your Mention Streams.

  • Id

  • Label

  • CreatedAt

  • UpdatedAt

  • QueryStyle

  • Keywords

  • Excluded Keywords

  • Default Sentiment Rating

  • Archived

  • MagazineContent

  • OnlineContent

  • PodcastContent

  • RadioContent

  • PrintContent

  • SocialContent

  • TVContent

Response Sample:

GET /streams

1 [

2 {

3 "id": 3349,

4 "label": "The Daily Show",

5 "createdAt": "2023-06-14T02:34:56.000Z",

6 "updatedAt": "2023-06-14T02:34:56.000Z",

7 "queryStyle": "boolean",

8 "keywords": "foo",

9 "excludedKeywords": "bar",

10 "defaultSentimentRating": 0,

11 "archived": false,

12 "magazineContent": true,

13 "onlineContent": true,

14 "podcastContent": true,

15 "printContent": true,

16 "radioContent": true,

17 "socialContent": true,

18 "tvContent": true

19 }

20 ]

21

Rate Limiting

Requests to the API may be limited to 10 requests per minute. It's limited by both your IP address, and the API Key you're using. Requests that exceed this limit may receive the standard 429 (Too Many Requests) HTTP response code.

Available Endpoints

Did this answer your question?