API atual/Referência completa/Dashboards do seller

Execuções de alerta

Executa uma assinatura na hora e consulta o histórico de execuções de alertas e agendamentos.

Use para testar uma assinatura recém-criada sem esperar o próximo ciclo e para saber por que um e-mail não chegou.

Executar agora

Avalia a assinatura imediatamente, como o ciclo horário faria, e devolve o registro da execução. Num alerta, o e-mail só sai se a regra estiver violada.

POST/api/v1/vendor/dashboards/subscriptions/{id}/runSeller

Executar agora

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da assinatura (UUID).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/dashboards/subscriptions/a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90/run" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Executada

json

{
  "message": "assinatura executada",
  "run": {
    "id": "5d0a1b26-3f4e-4ab0-8d57-1c2d3e4f5a6b",
    "subscription_id": "a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90",
    "status": "sent",
    "detail": "",
    "value": 225.0,
    "recipient_count": 1,
    "executed_at": "2026-10-11T22:05:00Z"
  }
}

Campos da resposta

messagestring

assinatura executada (texto em português, como o servidor devolve).

runobject

O registro da execução (campos em Histórico). Ausente se o registro não pôde ser lido.

Erros

Status	Quando	Corpo de exemplo
404	Assinatura inexistente ou de outro seller, ou o card/aba alvo não está visível.	`{"error":"assinatura não encontrada"}`
500	Falha ao executar.	`{"error":"falha ao executar a assinatura","detail":"..."}`
503	O recurso não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Histórico de execuções

GET/api/v1/vendor/dashboards/subscriptions/{id}/runsSeller

Histórico de execuções

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da assinatura (UUID).

Parâmetros de consulta

limitinteger

Quantas execuções devolver, das mais recentes. Omitido ou inválido: o padrão do servidor.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/dashboards/subscriptions/a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90/runs?limit=10" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execuções

json

{
  "runs": [
    {
      "id": "5d0a1b26-3f4e-4ab0-8d57-1c2d3e4f5a6b",
      "subscription_id": "a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90",
      "status": "sent",
      "detail": "",
      "value": 225.0,
      "recipient_count": 1,
      "executed_at": "2026-10-11T22:05:00Z"
    }
  ]
}

Campos da resposta

runsobject[]

As execuções.

runs[].iduuid

Id da execução.

runs[].subscription_iduuid

Assinatura.

runs[].statusstring

sentskippedfailed

sent enviada, skipped pulada (por exemplo, limiar não violado ou em cooldown), failed falhou.

runs[].detailstring

Motivo, quando houver.

runs[].valuenumber

Valor medido (alertas).

runs[].recipient_countinteger

Destinatários alcançados.

runs[].executed_atstring

Quando, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
404	Assinatura inexistente ou de outro seller, ou o card/aba alvo não está visível.	`{"error":"assinatura não encontrada"}`
500	Falha ao listar.	`{"error":"falha ao listar execuções"}`
503	O recurso não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Veja também

Alertas e agendamentos

API atual/Referência completa/Dashboards do seller

Execuções de alerta

Executa uma assinatura na hora e consulta o histórico de execuções de alertas e agendamentos.

Use para testar uma assinatura recém-criada sem esperar o próximo ciclo e para saber por que um e-mail não chegou.

Executar agora

Avalia a assinatura imediatamente, como o ciclo horário faria, e devolve o registro da execução. Num alerta, o e-mail só sai se a regra estiver violada.

POST/api/v1/vendor/dashboards/subscriptions/{id}/runSeller

Executar agora

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da assinatura (UUID).

Exemplo de requisição

bash

curl -X POST "$BASE_URL/api/v1/vendor/dashboards/subscriptions/a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90/run" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Executada

json

{
  "message": "assinatura executada",
  "run": {
    "id": "5d0a1b26-3f4e-4ab0-8d57-1c2d3e4f5a6b",
    "subscription_id": "a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90",
    "status": "sent",
    "detail": "",
    "value": 225.0,
    "recipient_count": 1,
    "executed_at": "2026-10-11T22:05:00Z"
  }
}

Campos da resposta

messagestring

assinatura executada (texto em português, como o servidor devolve).

runobject

O registro da execução (campos em Histórico). Ausente se o registro não pôde ser lido.

Erros

Status	Quando	Corpo de exemplo
404	Assinatura inexistente ou de outro seller, ou o card/aba alvo não está visível.	`{"error":"assinatura não encontrada"}`
500	Falha ao executar.	`{"error":"falha ao executar a assinatura","detail":"..."}`
503	O recurso não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Histórico de execuções

GET/api/v1/vendor/dashboards/subscriptions/{id}/runsSeller

Histórico de execuções

Cabeçalhos

Authorizationstringobrigatório

Bearer $TOKEN. Token de acesso do usuário seller (veja Tokens).

Parâmetros de caminho

iduuidobrigatório

Id da assinatura (UUID).

Parâmetros de consulta

limitinteger

Quantas execuções devolver, das mais recentes. Omitido ou inválido: o padrão do servidor.

Exemplo de requisição

bash

curl -X GET "$BASE_URL/api/v1/vendor/dashboards/subscriptions/a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90/runs?limit=10" \
  -H "Authorization: Bearer $TOKEN"

Resposta

200Execuções

json

{
  "runs": [
    {
      "id": "5d0a1b26-3f4e-4ab0-8d57-1c2d3e4f5a6b",
      "subscription_id": "a7c1e4d2-52f7-4bd0-9e0a-6c3f1b2a8d90",
      "status": "sent",
      "detail": "",
      "value": 225.0,
      "recipient_count": 1,
      "executed_at": "2026-10-11T22:05:00Z"
    }
  ]
}

Campos da resposta

runsobject[]

As execuções.

runs[].iduuid

Id da execução.

runs[].subscription_iduuid

Assinatura.

runs[].statusstring

sentskippedfailed

sent enviada, skipped pulada (por exemplo, limiar não violado ou em cooldown), failed falhou.

runs[].detailstring

Motivo, quando houver.

runs[].valuenumber

Valor medido (alertas).

runs[].recipient_countinteger

Destinatários alcançados.

runs[].executed_atstring

Quando, RFC 3339 em UTC.

Erros

Status	Quando	Corpo de exemplo
404	Assinatura inexistente ou de outro seller, ou o card/aba alvo não está visível.	`{"error":"assinatura não encontrada"}`
500	Falha ao listar.	`{"error":"falha ao listar execuções"}`
503	O recurso não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`
401	Token ausente, inválido, expirado ou revogado.	`invalid or expired token`
403	O token não é de um usuário seller, ou a loja ainda está em análise de cadastro.	`{"error":"vendor_pending_review"}`

Veja também

Alertas e agendamentos