curl --request GET \
--url https://api.peakmetrics.com/workspaces \
--header 'Authorization: Bearer <token>'[
{
"id": 2,
"title": "<string>",
"owner": "<string>",
"query": "<string>",
"channels": [
"news"
],
"narrativeDetection": {
"status": "new"
},
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"folder": {
"id": 123,
"title": "<string>"
},
"summary": "<string>"
}
]Get workspaces.
A Workspace centralizes everything you need to know about an organization, individual, or topic in media. It defines a segment of the media ecosystem you’re interested in analyzing and is comprised of all related mentions.
Workspaces allow you to monitor and compare how your brand, competitors, industry, or topics are mentioned within mainstream conversations across multiple channels.
Typical Workspaces:
- Companies or brands (e.g., “Home Depot”)
- Key executives or public figures
- Industries or topics (e.g., “Artificial Intelligence”)
- Geographic regions or groups of sources
Features:
- AI-generated summaries of workspace activity
- Narrative detection to identify emerging themes
- Multi-channel monitoring across news, social, and discussion platforms
- Customizable queries using Boolean operators
curl --request GET \
--url https://api.peakmetrics.com/workspaces \
--header 'Authorization: Bearer <token>'[
{
"id": 2,
"title": "<string>",
"owner": "<string>",
"query": "<string>",
"channels": [
"news"
],
"narrativeDetection": {
"status": "new"
},
"created": "2023-11-07T05:31:56Z",
"modified": "2023-11-07T05:31:56Z",
"folder": {
"id": 123,
"title": "<string>"
},
"summary": "<string>"
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
If value provided is "true", summaries will be generated for each workspace returned.
Response
A JSON array of workspace objects
The unique identifier for the workspace.
x >= 1The user entered title of the workspace.
The unique identifier of the user who owns the workspace.
The query used to match mentions to the workspace.
The unique identifiers of the channels that are part of the workspace.
news, reddit, telegram, twitter, youtube Show child attributes
Show child attributes
The date and time the workspace was created.
The date and time the workspace was last updated.
The folder, if any, this workspace belongs to.
Show child attributes
Show child attributes
The summary of the given workspace, if summary=true is passed in the query string (defaults to an empty string otherwise).
Was this page helpful?