API atual/Referência completa/Dashboards

Assinaturas: executar e histórico

Dispara uma assinatura na hora, para testar, e consulta o histórico das execuções dela.

run força uma execução imediata da assinatura, sem esperar a próxima hora ou dia, e envia o e-mail de verdade para os destinatários. É o botão "Testar". O cooldown de um alerta continua valendo. runs lista as execuções já feitas, da mais recente para a mais antiga, com o resultado de cada uma.

Executar agora

POST/api/v1/admin/dashboards/subscriptions/{id}/runAdmin

Executar uma assinatura agora

Parâmetros de caminho

iduuidobrigatório

Id da assinatura.

Exemplo de requisição (run)

bash

curl -X POST "$BASE_URL/api/v1/admin/dashboards/subscriptions/f9f99133-ba51-49df-8f85-30ae9fd90eac/run" \
  -H "Authorization: Bearer $TOKEN"

Resposta (run)

200Executada

json

{
  "message": "assinatura executada",
  "run": {
    "id": "0b7c2d0a-6d4e-4b9a-9d0b-1e0f0c8a1b11",
    "subscription_id": "f9f99133-ba51-49df-8f85-30ae9fd90eac",
    "status": "sent",
    "recipient_count": 1,
    "executed_at": "2026-10-11T21:15:02Z"
  }
}

Campos da resposta

messagestring

Confirmação em português do servidor.

runobject

O registro desta execução, no formato do item de runs abaixo. Ausente se o registro não pôde ser lido.

Erros (run)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"manage_dashboards"}`
404	A assinatura não existe ou o alvo dela não é visível para você.	`{"error":"assinatura não encontrada"}`
500	Falha ao executar.	`{"error":"falha ao executar a assinatura"}`
503	O recurso de assinaturas não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`

Histórico

GET/api/v1/admin/dashboards/subscriptions/{id}/runsAdmin

Histórico de execuções

Parâmetros de caminho

iduuidobrigatório

Id da assinatura.

Parâmetros de consulta

limitintegerpadrão: 20

Quantas execuções devolver, de 1 a 100. Fora disso vale 20.

Exemplo de requisição (histórico)

bash

curl "$BASE_URL/api/v1/admin/dashboards/subscriptions/f9f99133-ba51-49df-8f85-30ae9fd90eac/runs?limit=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta (histórico)

200Execuções

json

{
  "runs": [
    {
      "id": "0b7c2d0a-6d4e-4b9a-9d0b-1e0f0c8a1b11",
      "subscription_id": "f9f99133-ba51-49df-8f85-30ae9fd90eac",
      "status": "sent",
      "recipient_count": 1,
      "executed_at": "2026-10-11T21:15:02Z"
    }
  ]
}

Campos da resposta

runsarray

Execuções, da mais recente para a mais antiga. [] se nunca rodou.

runs[].iduuid

Id da execução.

runs[].subscription_iduuid

Assinatura.

runs[].statusstring

sentskippedfailed

sent enviou, skipped não enviou (por exemplo, alerta dentro do cooldown ou limiar não violado), failed falhou.

runs[].detailstring

Explicação curta, quando existe.

runs[].valuenumber

Valor medido (alertas).

runs[].recipient_countinteger

Destinatários do envio.

runs[].executed_atstring

Quando rodou, RFC 3339.

Erros (histórico)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"view_reports"}`
404	A assinatura não existe ou o alvo dela não é visível para você.	`{"error":"assinatura não encontrada"}`
500	Falha inesperada no servidor.	`{"error":"falha ao listar execuções"}`
503	O recurso de assinaturas não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`

Veja também

Assinaturas: executar e histórico

Dispara uma assinatura na hora, para testar, e consulta o histórico das execuções dela.

Executar agora

POST/api/v1/admin/dashboards/subscriptions/{id}/runAdmin

Executar uma assinatura agora

Parâmetros de caminho

iduuidobrigatório

Id da assinatura.

Exemplo de requisição (run)

bash

curl -X POST "$BASE_URL/api/v1/admin/dashboards/subscriptions/f9f99133-ba51-49df-8f85-30ae9fd90eac/run" \
  -H "Authorization: Bearer $TOKEN"

Resposta (run)

200Executada

json

{
  "message": "assinatura executada",
  "run": {
    "id": "0b7c2d0a-6d4e-4b9a-9d0b-1e0f0c8a1b11",
    "subscription_id": "f9f99133-ba51-49df-8f85-30ae9fd90eac",
    "status": "sent",
    "recipient_count": 1,
    "executed_at": "2026-10-11T21:15:02Z"
  }
}

Campos da resposta

messagestring

Confirmação em português do servidor.

runobject

O registro desta execução, no formato do item de runs abaixo. Ausente se o registro não pôde ser lido.

Erros (run)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"manage_dashboards"}`
404	A assinatura não existe ou o alvo dela não é visível para você.	`{"error":"assinatura não encontrada"}`
500	Falha ao executar.	`{"error":"falha ao executar a assinatura"}`
503	O recurso de assinaturas não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`

Histórico

GET/api/v1/admin/dashboards/subscriptions/{id}/runsAdmin

Histórico de execuções

Parâmetros de caminho

iduuidobrigatório

Id da assinatura.

Parâmetros de consulta

limitintegerpadrão: 20

Quantas execuções devolver, de 1 a 100. Fora disso vale 20.

Exemplo de requisição (histórico)

bash

curl "$BASE_URL/api/v1/admin/dashboards/subscriptions/f9f99133-ba51-49df-8f85-30ae9fd90eac/runs?limit=20" \
  -H "Authorization: Bearer $TOKEN"

Resposta (histórico)

200Execuções

json

{
  "runs": [
    {
      "id": "0b7c2d0a-6d4e-4b9a-9d0b-1e0f0c8a1b11",
      "subscription_id": "f9f99133-ba51-49df-8f85-30ae9fd90eac",
      "status": "sent",
      "recipient_count": 1,
      "executed_at": "2026-10-11T21:15:02Z"
    }
  ]
}

Campos da resposta

runsarray

Execuções, da mais recente para a mais antiga. [] se nunca rodou.

runs[].iduuid

Id da execução.

runs[].subscription_iduuid

Assinatura.

runs[].statusstring

sentskippedfailed

sent enviou, skipped não enviou (por exemplo, alerta dentro do cooldown ou limiar não violado), failed falhou.

runs[].detailstring

Explicação curta, quando existe.

runs[].valuenumber

Valor medido (alertas).

runs[].recipient_countinteger

Destinatários do envio.

runs[].executed_atstring

Quando rodou, RFC 3339.

Erros (histórico)

Status	Quando	Corpo
401	Sem token, token inválido ou expirado.	`{"error":"missing authorization header"}`
403	O usuário não tem o privilégio exigido.	`{"error":"insufficient privileges","required":"view_reports"}`
404	A assinatura não existe ou o alvo dela não é visível para você.	`{"error":"assinatura não encontrada"}`
500	Falha inesperada no servidor.	`{"error":"falha ao listar execuções"}`
503	O recurso de assinaturas não está configurado neste ambiente.	`{"error":"assinaturas de dashboard não estão configuradas neste ambiente"}`