Skip to main content
GET
/
workspaces
/
{workspaceId}
/
available-filters
Available mention filters
curl --request GET \
  --url https://api.peakmetrics.com/workspaces/{workspaceId}/available-filters \
  --header 'Authorization: Bearer <token>'
{
  "channels": {
    "name": "Channels",
    "key": "channels",
    "options": [
      {
        "name": "News",
        "value": "news"
      }
    ]
  },
  "languages": {
    "name": "Languages",
    "key": "languages",
    "options": [
      {
        "name": "English",
        "value": "en"
      }
    ]
  },
  "bot_ratings": {
    "name": "Bot Detection",
    "key": "bot_ratings",
    "options": [
      {
        "name": "Almost Certain",
        "value": "almost_certain"
      }
    ]
  },
  "smart_categories": {
    "name": "Smart Categories",
    "key": "smart_categories",
    "models": [
      {
        "name": "JP Morgan Sentiment",
        "enrichment_id": 244,
        "options": [
          {
            "name": "Positive",
            "value": "244:c0"
          }
        ]
      }
    ],
    "mention_type": {
      "name": "Mention Type",
      "social_media": {
        "name": "Social Media Posts",
        "key": "mention_type.social_media",
        "options": [
          {
            "name": "Original Posts",
            "value": "original_posts"
          }
        ]
      },
      "news": {
        "name": "News Articles",
        "key": "mention_type.news",
        "options": [
          {
            "name": "News",
            "value": "news"
          }
        ]
      },
      "podcasts": {
        "name": "Podcasts",
        "key": "mention_type.podcasts",
        "options": [
          {
            "name": "Podcasts",
            "value": "podcasts"
          }
        ]
      }
    }
  },
  "publisher_geography": {
    "name": "Publisher Geography (News Only)",
    "source_country": {
      "name": "Source Country",
      "key": "publisher_geography.source_country",
      "options": [
        {
          "name": "United States",
          "value": "United States"
        }
      ]
    },
    "source_region": {
      "name": "Source Region",
      "key": "publisher_geography.source_region",
      "options": [
        {
          "name": "Americas",
          "value": "Americas"
        }
      ]
    },
    "source_sub_region": {
      "name": "Source Subregion",
      "key": "publisher_geography.source_sub_region",
      "options": [
        {
          "name": "Northern America",
          "value": "Northern America"
        }
      ]
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workspaceId
integer
required

The unique identifier for the workspace.

Required range: x >= 1

Response

A JSON object containing the available filters for the workspace.

​
channels
object

Available channel filters for this workspace.

​
languages
object

Available language filters.

​
bot_ratings
object

A social media account's likelihood of being automated.

This filter returns an empty options array if the workspace does not have at least one supported social channel.

Values are on a 7 point scale ranging from very_unlikely to almost_certain, with high-follower accounts indicated as further_investigation.

​
smart_categories
object

Available Smart Category filters for this workspace. Smart Categories are custom AI-powered classifiers configured per workspace (e.g., sentiment models, topic classifiers, violent rhetoric detection). Each model is listed as a separate entry with its own set of classification options.

The filter returns an empty models array if no Smart Categories are configured for the workspace.

​
publisher_geography
object

Available publisher geography filters. Primarily applicable to news mentions. Contains separate sub-filters for country, region, and subregion, each with their own key and options.

All sub-filter options arrays are empty if the workspace does not include the news channel.