curl --request GET \
--url https://api.peakmetrics.com/workspaces/{workspaceId}/narratives \
--header 'Authorization: Bearer <token>'[
{
"id": 2,
"title": "<string>",
"isFavorite": true,
"aggregations": {
"mentionCount": 1,
"avgSentiment": 0,
"relevancyScore": 50
},
"created": "2023-11-07T05:31:56Z",
"summary": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}
]Get narratives within the provided workspace ID.
Narratives are AI-powered clusters of related mentions that share common themes or storylines. PeakMetrics’ narrative clustering algorithms distill thousands of mentions into easily digestible narratives, helping you quickly understand key themes without manual analysis.
Example: 220,000 mentions can be condensed into just 315 key narratives.
Each narrative includes:
- AI-generated title and summary
- Aggregated metrics (mention count, average sentiment, relevancy score)
- User-assigned tags for organization
- Favorite status for quick access
Use Cases:
- Identify emerging threats or opportunities early
- Track how narratives morph over time
- Understand the voices and sources driving conversations
- Monitor narrative sentiment across different channels
curl --request GET \
--url https://api.peakmetrics.com/workspaces/{workspaceId}/narratives \
--header 'Authorization: Bearer <token>'[
{
"id": 2,
"title": "<string>",
"isFavorite": true,
"aggregations": {
"mentionCount": 1,
"avgSentiment": 0,
"relevancyScore": 50
},
"created": "2023-11-07T05:31:56Z",
"summary": "<string>",
"tags": [
{
"id": 123,
"name": "<string>",
"createdDate": "2023-11-07T05:31:56Z"
}
]
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The unique identifier for the workspace.
Query Parameters
The maximum number of narratives to return, default 1000.
1 <= x <= 1000The number of narratives to skip before returning, default 0.
x >= 0The field to sort the narratives by descending, default relevancy.
relevancy, mentionCount, avgSentiment, created, favorite The minimum published date of the mentions to include in the narratives.
The maximum published date of the mentions to include in the narratives.
Filter the returned narratives to those whose mentions are part of the provided channel.
blogsdiscussions, bluesky, facebook, instagram, news, reddit, redditComment, telegram, threads, tiktok, twitter, vk, weibo, youtube Response
A JSON array of narrative objects
The unique identifier for the narrative.
x >= 1The AI generated title for the narrative.
Favorited status of narrative for requesting user.
Show child attributes
Show child attributes
The date and time the narrative was created.
The summary of the given narrative.
Tags assigned by team members to the narrative.
Show child attributes
Show child attributes
Was this page helpful?