POST/v1/segments

Criar segmento

Cria um segmento a partir de grupos de regras. Os grupos são combinados com OU e as regras dentro de um grupo com E. A resposta já traz quantos dispositivos ativos entram no segmento agora.

A lista completa de tipos de regra e operadores está no guia de segmentos (/guias/segmentos).

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokenchaveSecretaoptional

Stored only in this browser for the chaveSecreta security scheme and reused on every API page in this group.

Request body

application/jsonrequired

namestringrequired

Nome do segmento, até 255 caracteres.

definitionrequired

Responses

201application/json

Segmento criado.

{
  "id": 42,
  "name": "Clientes VIP do Sudeste",
  "definition": {
    "version": 2,
    "groups": [
      {
        "rules": [
          {
            "type": "tags",
            "op": "has_any",
            "values": [
              "vip"
            ]
          },
          {
            "type": "region",
            "op": "in",
            "values": [
              "SP",
              "RJ",
              "MG",
              "ES"
            ]
          }
        ]
      }
    ]
  },
  "audience_count": 1843,
  "subscriber_count": 1290,
  "warnings": []
}

idintegeroptional

namestringoptional

definitionoptional

audience_countintegeroptional

Quantos dispositivos com inscrição ativa atendem às regras agora. Uma pessoa com dois aparelhos conta duas vezes.

subscriber_countintegeroptional

Quantos assinantes distintos estão por trás desses dispositivos, ou seja, quantas pessoas.

warningsarray<string>optional

Regras que não puderam ser aplicadas, como uma campanha de outro site. Uma regra com aviso não seleciona ninguém, então o grupo dela fica vazio.

401application/json

Chave ausente, inválida ou revogada.

{
  "message": "Credencial ausente ou inválida."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.

422application/json

Algum campo não passou na validação. errors traz a mensagem de cada campo.

{
  "message": "O campo content.title é obrigatório.",
  "errors": {
    "content.title": [
      "O campo content.title é obrigatório."
    ]
  }
}

messagestringoptional

Primeira mensagem de erro.

errorsobjectoptional

Mensagens por campo. A chave é o caminho do campo com pontos, como content.title ou definition.groups.0.rules.1.op.

429application/json

Limite de requisições excedido. Espere os segundos indicados em Retry-After.

{
  "message": "Muitas requisições. Tente novamente em instantes."
}

messagestringoptional

Descrição do erro, em português. Quando a causa não tem mensagem própria, vem a mensagem padrão do código HTTP. Trate pelo código, não pelo texto.