Ver .md

groups.rotation_simulate

Simular a rotação antes de lançar. Simula clicks cliques (1 a 20000) na rotação do link principal (linkId nulo) ou de um link extra, com joinRate (0 a 1, padrão 0,8) de entradas. Nada é gravado. Devolve {perGroup: [{groupId, name, clicks, joins, fullAtClick}], firstFullAt, noSeatAt, totalReserved}.

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

Entrada

CampoTipoObrigatórioNota
campaignIdstring (uuid)sim
linkIdstring (uuid) | nullnão
clicksintegersim
joinRatenumbernãopadrão 0.8
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "campaignId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "linkId": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
        },
        {
          "type": "null"
        }
      ]
    },
    "clicks": {
      "type": "integer",
      "minimum": 1,
      "maximum": 20000
    },
    "joinRate": {
      "default": 0.8,
      "type": "number",
      "minimum": 0,
      "maximum": 1
    }
  },
  "required": [
    "campaignId",
    "clicks"
  ]
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/groups.rotation_simulate \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"campaignId":"00000000-0000-4000-8000-000000000001","clicks":5000,"joinRate":0.8}'

CLI:

node cli/atomiks.mjs groups.rotation_simulate --json '{"campaignId":"00000000-0000-4000-8000-000000000001","clicks":5000,"joinRate":0.8}'

MCP: ferramenta groups_rotation_simulate com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "propertyNames": {
    "type": "string"
  },
  "additionalProperties": {}
}

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).