links
GET /v1/content/runs/{runId}
One run, with every site's outcome.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/content/runs/{runId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
The whole run screen in one call. Gated on `links.view`. 404 rather than 403 for a run in another tenant — a 403 would confirm the row exists.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
runId (path) | string | Oui | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | string | Oui | — |
state | ContentRunState | Oui | Where a run got to. `partial` is a real, honest, terminal answer and not a euphemism: some sites published and some did not, nothing is left to try, and the failures can be resu… |
publish_policy | ContentRunPublishPolicy | Oui | How far a run may go on its own. `draft_only` is the default and puts nothing live. |
recipe_id | string | Non | — |
brief | string | Oui | — |
category | string | Non | — |
post_id | string | Non | The article this run wrote. Written once and reused for every site, so a resumed run places the SAME copy rather than paying for a second generation. |
attempt | integer | Oui | Which pass over the failures this is. 0 is the original run. |
workflow_id | string | Non | — |
totals | ContentRunTotals | Oui | — |
reason | ContentRunFailureReason | Non | — |
provider | string | Non | — |
message | string | Non | An English sentence for the customer. Clients should render their own localised text from `reason` and fall back to this only for a code they do not know. |
resumable | boolean | Oui | Whether a resume would actually do anything. False on a paused run with nothing failed — do not offer the button when this is false. |
started_at | string | Non | — |
finished_at | string | Non | — |
created_at | string | Oui | — |
items | ContentRunItem[] | Oui | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404