Listar o status de sincronização do trabalho

get

/cdi/integrations/{integration_id}/job_sync_status

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

note:

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

Limite de taxa

This endpoint has a rate limit of 100 requests per minute.

Parâmetros da jornada

Parâmetro	Obrigatória	Tipo de dados	Descrição
`integration_id`	Obrigatória	String	ID de integração.

Parâmetros de consulta

Cada chamada a esse ponto de extremidade 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.

Parâmetro	Obrigatória	Tipo de dados	Descrição
`cursor`	Opcional	String	Determina a paginação do status de sincronização.

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.

note:

O cabeçalho Link não existirá se houver menos ou igual a 10 sincronizações no total. Nas chamadas sem cursor, o endereço prev não será exibido. Ao olhar 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"

{
  "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"
}

job_status	Explicação
`running`	O trabalho está em execução no momento.
`success`	Todas as linhas foram sincronizadas com sucesso.
`partial`	Algumas linhas não puderam ser sincronizadas devido a erros.
`error`	Nenhuma linha foi sincronizada.
`config_error`	Houve um erro na configuração da integração. Verifique sua configuração de integração.

Solução de problemas

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

Erro	Solução de problemas
`400 Invalid cursor`	Verifique se o site `cursor` é válido.
`400 Invalid integration ID`	Verifique se o site `integration_id` é válido.

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

Editar esta página no GitHub

QUÃO ÚTIL FOI ESTA PÁGINA?

OBTER: Integrações de listas

POST: Disparar Sync

Editar esta página no GitHub

New Stuff!