Listar status de sincronização do trabalho

Use esse endpoint para retornar uma lista de status de sincronização anteriores para uma determinada integração.

Nota

Para usar esse endpoint, você precisará gerar uma chave de API com a permissão cdi.integration_job_status.

Limite de taxa

Esse endpoint tem um limite de taxa de 100 solicitações por minuto.

Parâmetros de jornada

Parâmetros de consulta

Cada chamada a esse endpoint retornará 10 itens. Para uma integração com mais de 10 sincronizações, use o cabeçalho Link para recuperar os dados na próxima página, conforme mostrado no exemplo de resposta a seguir.

Exemplo de solicitação

Sem cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations/00000000-0000-0000-0000-000000000000/job_sync_status' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Com cursor

1
2
3
curl --location --request GET 'https://rest.iad-03.braze.com/cdi/integrations/00000000-0000-0000-0000-000000000000/job_sync_status?cursor=c2tpcDow' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR-REST-API-KEY'

Resposta

Exemplo de resposta bem-sucedida

O código de status 200 poderia retornar o seguinte corpo de resposta.

Nota

O cabeçalho Link não existirá se houver 10 sincronizações ou menos no total. Nas chamadas sem cursor, prev não será exibido. Ao visualizar a última página de itens, next não será exibido.

1
Link: </cdi/integrations/00000000-0000-0000-0000-000000000000/job_sync_status?cursor=c2tpcDow>; rel="prev",</cdi/integrations00000000-0000-0000-0000-000000000000/job_sync_status?cursor=c2tpcDoxMDA=>; rel="next"

1
2
3
4
5
6
7
8
9
10
11
12
13
{
  "results": [
    {
        "job_status": (string) status of the sync, see below for explanation of different statuses,
        "sync_start_time": (string) time the sync started in ISO 8601,
        "sync_finish_time": (string) time the sync finished in ISO 8601,
        "last_timestamp_synced": (string) last UPDATED_AT timestamp processed by the sync in ISO 8601,
        "rows_synced": (integer) number of rows successfully synced to Braze,
        "rows_failed_with_errors": (integer) number of rows failed because of errors
    }
  ],
  "message": "success"
}

Solução de problemas

A tabela a seguir lista os possíveis erros retornados e as etapas de solução de problemas associadas.

Para códigos de status adicionais e mensagens de erro associadas, consulte Erros fatais e respostas.