Skip to main content
GET
/
workspaces
Workspaces
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

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
summary
string

If value provided is "true", summaries will be generated for each workspace returned. A duplicate request may be necessary to fetch the summaries.

Response

200 - application/json

A JSON array of workspace objects

​
id
integer

The unique identifier for the workspace.

Required range: x >= 1
​
title
string

The user entered title of the workspace.

​
owner
string

The unique identifier of the user who owns the workspace.

​
query
string

The query used to match mentions to the workspace.

​
channels
enum<string>[]

The unique identifiers of the channels that are part of the workspace.

Available options:
news,
reddit,
telegram,
twitter,
youtube
​
narrativeDetection
object
​
created
string<date-time>

The date and time the workspace was created.

​
modified
string<date-time>

The date and time the workspace was last updated.

​
folder
object

The folder, if any, this workspace belongs to.

​
summary
string

The summary of the given workspace, if summary=true is passed in the query string (defaults to an empty string otherwise).