Liste de l’état de synchronisation des travaux
/cdi/integrations/{integration_id}/job_sync_status
Utilisez cet endpoint pour renvoyer une liste des états de synchronisation passés pour une intégration donnée.
Pour utiliser cet endpoint, vous devrez générer une clé API avec l’autorisation cdi.integration_job_status
.
Limite de débit
This endpoint has a rate limit of 100 requests per minute.
Paramètres de chemin
Paramètre | Requis | Type de données | Description |
---|---|---|---|
integration_id |
Requis | Chaîne de caractères | ID d’intégration. |
Paramètres de recherche
Chaque appel à cet endpoint renverra 10 éléments. Pour une intégration avec plus de 10 synchronisations, utilisez l’en-tête Link
pour récupérer les données sur la page suivante, comme le montre l’exemple de réponse suivant.
Paramètre | Requis | Type de données | Description |
---|---|---|---|
cursor |
Facultatif | Chaîne de caractères | Détermine la pagination de l’état de synchronisation. |
Exemple de demande
Sans curseur
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'
Avec curseur
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'
Réponse
Exemple de réponse réussie
Le code de statut 200
pourrait renvoyer le corps de réponse suivant.
L’en-tête Link
n’existe pas si le nombre total de synchronisations est inférieur ou égal à 10. Pour les appels sans curseur, prev
ne s’affichera pas. Lors de la consultation de la dernière page de produits, next
ne s’affichera pas.
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"
}
état_du_travail | Explication |
---|---|
running |
Le travail est en cours d’exécution. |
success |
Toutes les lignes ont été synchronisées avec succès. |
partial |
Certaines lignes n’ont pas été synchronisées en raison d’erreurs. |
error |
Aucune ligne n’a été synchronisée. |
config_error |
Une erreur s’est produite dans la configuration de l’intégration. Vérifiez votre configuration d’intégration. |
Résolution des problèmes
Le tableau suivant répertorie les erreurs renvoyées possibles et les étapes de résolution des problèmes associées.
Erreur | Résolution des problèmes |
---|---|
400 Invalid cursor |
Vérifiez que votre cursor est valide. |
400 Invalid integration ID |
Vérifiez que votre integration_id est valide. |
Pour connaître les autres codes d’état et les messages d’erreur associés, veuillez vous reporter à la section Erreurs fatales et réponses.