Topics

Preview topic

Estimate the number of monthly mentions for a topic query before creating a topic. This helps you check if your query is within your plan limits and if sampling is available.

post/topics/preview

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/preview/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

samplingnumber

Sampling rate (0 < value ≤ 1). Optional (default value is 1 — full sample).

Example request

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

Response

Estimation result.

monthlyCountinteger

Estimated number of mentions per month for the query.

monthlyLimitinteger

Monthly mentions limit of your subscription plan.

isWithinLimitboolean

Whether the estimated count fits into the plan limit.

samplingAllowedboolean

Whether sampling is available in your subscription plan.

samplingnumber nullable

Sampling rate echoed from the request.

Changes

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