Topics

Update topic query

Updates an existing topic's query parameters.

post/topics/{topicId}/query/edit

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

Path parameters

topicIdinteger required

ID of the Topic.

Request body

Example request

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

Response

Updated topic.

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.