AtomiksAPI
Ver .md

subscriptions.filter_options

Opções dos filtros de assinaturas. UTMs (source, medium, campaign, term), produtos e ofertas vistos nas assinaturas, para os filtros da aba Coortes.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/subscriptions.filter_options (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: crm:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: subscriptions_filter_options
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId subscriptions.filter_options)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/subscriptions.filter_options \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs subscriptions.filter_options --json '{}'

MCP: ferramenta subscriptions_filter_options com a mesma entrada.

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "utmSource": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "utmMedium": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "utmCampaign": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "utmTerm": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "products": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "additionalProperties": false
      }
    },
    "offers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "id",
          "name"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "utmSource",
    "utmMedium",
    "utmCampaign",
    "utmTerm",
    "products",
    "offers"
  ],
  "additionalProperties": false
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).