OrbitSenderDocs
ReferenceSegmentos

Configurar monitoramento de grupo

POST
/api/external/monitoring/group

Configura um grupo de destino para monitoramento de um segmento. O grupo informado não pode já fazer parte do segmento.

Authorization

x-api-key<token>

Chave de API no formato sk_live_..., no header x-api-key.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/external/monitoring/group" \  -H "Content-Type: application/json" \  -d '{    "id_segment": "string",    "id_channel": "string",    "id_group": "string"  }'
{  "success": true,  "message": "string",  "id_segment": "string",  "monitoring_group": {    "id_group": "string",    "name": "string",    "id_channel": "string",    "channel_name": "string"  },  "timestamp": "2019-08-24T14:15:22Z"}
{  "success": false,  "error": "Bad Request",  "message": "O campo \"name\" é obrigatório no body da requisição."}
{  "success": false,  "error": "Unauthorized",  "message": "Chave de API inválida ou ausente."}
{  "success": false,  "error": "Not Found",  "message": "Segmento não encontrado."}
{  "success": false,  "error": "Conflict",  "message": "Este grupo já está configurado como monitoramento para este segmento."}
{  "success": false,  "error": "Too Many Requests",  "code": "rate_limited",  "message": "Muitas requisições. Tente novamente em instantes."}
{  "success": false,  "error": "Internal Server Error",  "message": "Erro interno ao processar a requisição."}
{  "success": false,  "error": "Service Unavailable",  "message": "Não foi possível consultar os grupos. Tente novamente em instantes."}