Topics

Create topic

Creates a new topic for mention monitoring.

post/topics

Request

Base URL
https://api.youscan.io/api/external
Auth
- API key in header X-API-KEY
- or API key in query parameter apiKey
TypeScript
https://skmtc.dev/youscan/apis/youscan-api/docs/topics/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring required

Name of the topic (1-75 characters).

samplingnumber

Sampling rate (0 < value ≤ 1). Allows you to monitor a fraction of all matching mentions. Requires a subscription plan with sampling support, otherwise the request is rejected with 400. Optional (default value is 1 — full sample).

Example request

{
  "topicQuery": {
    "filter": {
      "filters": [
        {
          "fieldName": "country",
          "op": "notOneOf",
          "value": "[\"ua\"]"
        }
      ]
    }
  }
}

Response

Topic created.

idinteger

Topic ID.

namestring

Topic name.

samplingnumber nullable

Sampling rate, if sampling is enabled for the topic.

Example response

{
  "topicQuery": {
    "filter": {
      "filters": [
        {
          "fieldName": "country",
          "op": "notOneOf",
          "value": "[\"ua\"]"
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.