Obtenir l'activité d'une automatisation

Journal d’audit paginé par curseur pour une automatisation

GET /automations/:id/activity

cURL — first page

curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ/activity?limit=25"

curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ/activity?limit=25&next=eyJ0aW1lIjoiMjAyNi0wNS0xMlQw..."

const API_KEY = "API_KEY";
const id = "auto_9xKp2Lm4nQ";

// Paginate through every page
let next;
do {
  const url = new URL(`https://api.ayrshare.com/api/automations/${id}/activity`);
  url.searchParams.set("limit", "25");
  if (next) url.searchParams.set("next", next);

  const res = await fetch(url, {
    headers: { "Authorization": `Bearer ${API_KEY}` },
  });
  const json = await res.json();
  console.log(json.activity);
  next = json.meta?.pagination?.hasMore ? json.meta.pagination.next : undefined;
} while (next);

import requests

headers = {"Authorization": "Bearer API_KEY"}
automation_id = "auto_9xKp2Lm4nQ"

params = {"limit": 25}
while True:
    r = requests.get(
        f"https://api.ayrshare.com/api/automations/{automation_id}/activity",
        params=params,
        headers=headers,
    ).json()
    print(r["activity"])
    pagination = r.get("meta", {}).get("pagination", {})
    if not pagination.get("hasMore"):
        break
    params["next"] = pagination["next"]

$id = "auto_9xKp2Lm4nQ";
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.ayrshare.com/api/automations/" . $id . "/activity?limit=25",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer API_KEY"],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

200: Success

{
  "status": "success",
  "automationId": "auto_9xKp2Lm4nQ",
  "activity": [
    {
      "id": "auto_9xKp2Lm4nQ:trg_a1b2c3:18012345678901234",
      "automationId": "auto_9xKp2Lm4nQ",
      "triggerId": "trg_a1b2c3",
      "triggerType": "comment_keyword",
      "recipientId": "17841401234567890",
      "recipientUsername": "jane_doe",
      "eventId": "18012345678901234",
      "platform": "instagram",
      "status": "sent",
      "actionResults": [
        {
          "actionId": "act_d4e5f6",
          "type": "send_dm",
          "status": "sent",
          "completedAt": "2026-05-12T09:14:48.000Z"
        }
      ],
      "keyword": "LINK",
      "commentText": "Send me the LINK please!",
      "created": "2026-05-12T09:14:22.000Z",
      "completedAt": "2026-05-12T09:14:48.000Z"
    },
    {
      "id": "auto_9xKp2Lm4nQ:trg_a1b2c3:18012345678900000",
      "automationId": "auto_9xKp2Lm4nQ",
      "triggerId": "trg_a1b2c3",
      "triggerType": "comment_keyword",
      "recipientId": "17841409876543210",
      "recipientUsername": "repeat_user",
      "eventId": "18012345678900000",
      "platform": "instagram",
      "status": "deduplicated",
      "actionResults": [],
      "keyword": "LINK",
      "commentText": "LINK again please",
      "created": "2026-05-12T09:00:11.000Z",
      "completedAt": "2026-05-12T09:00:34.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": true,
      "limit": 25,
      "next": "eyJ0aW1lIjoiMjAyNi0wNS0xMlQwOTowMDoxMS4wMDBaIiwiaWQiOiJhdXRvXzl4S3AyTG00blE6dHJnX2ExYjJjMzoxODAxMjM0NTY3ODkwMDAwMCJ9"
    }
  }
}

{
  "status": "error",
  "message": "limit must be a positive integer"
}

{
  "status": "error",
  "message": "'previous' pagination is not supported by this endpoint"
}

{
  "action": "automation",
  "status": "error",
  "code": 469,
  "message": "Automation not found"
}

Bêta. Voir la Vue d’ensemble des automatisations pour la description complète de la fonctionnalité.

Renvoie chaque tentative d’envoi pour une automatisation, la plus récente en premier. Chaque ligne enregistre le destinataire, le déclencheur correspondant, le résultat de chaque action et toute erreur.

Les lignes des 30 derniers jours sont retournées. Les lignes plus anciennes existent dans Firestore (la rétention est indéfinie pour l’analyse) mais sont exclues de ce point de terminaison pour des raisons de performance.

​

Statut des lignes d’activité

Chaque ligne a un status de premier niveau plus un status par action à l’intérieur d’actionResults[].

Statut	Quand il est enregistré
pending	La ligne vient d’être écrite ; le worker ne l’a pas encore prise en charge
in_flight	Le worker est en train d’envoyer
sent	Toutes les actions ont réussi
failed	Au moins une action a échoué (et aucune n’a rencontré d’erreur d’auth)
auth_error	Le jeton d’accès Instagram était invalide ; le DM n’a pas été retenté
rate_limited	Le plafond quotidien de DM (par palier ou par profil) a été atteint. Aucun DM n’a été envoyé
deduplicated	Cette action a déjà été déclenchée pour ce destinataire dans sa fenêtre de dédup (par défaut 7 jours, configurable par action)
skipped	L’automatisation est devenue inactive ou a été supprimée entre le fan-out et l’envoi

pending et in_flight sont transitoires ; tout le reste est terminal.

​

Paramètres d’en-tête

​

Paramètres de chemin

id · string · requis

L’ID d’automatisation retourné par POST /automations.

​

Paramètres de requête

limit · number · défaut: 25

Taille de page. Par défaut 25, max 100. Les valeurs en dehors de [1, 100] sont ramenées à cette plage ; les valeurs non entières ou ≤0 retournent HTTP 400.

next · string

Curseur opaque provenant de meta.pagination.next d’une réponse précédente. Omettez-le à la première requête.

Vers l’avant uniquement — passer ?previous= renvoie HTTP 400.

​

Forme de la réponse

La réponse enveloppe la liste de résultats dans activity[] et les infos du curseur dans meta.pagination :

{
  "status": "success",
  "automationId": "auto_9xKp2Lm4nQ",
  "activity": [ /* …rows, newest first… */ ],
  "meta": {
    "pagination": {
      "hasMore": true,
      "limit": 25,
      "next": "eyJ0aW1lIjoiMjAyNi0wNS0xMlQwOTowMDoxMS4wMDBaIiwiaWQiOiJhdXRvXzl4S3AyTG00blE6dHJnX2ExYjJjMzpjb21tZW50X3JlY2VpdmVkOjE4MDEyMzQ1Njc4OTAwMDAwIn0="
    }
  }
}

meta.pagination.next est un blob opaque encodé en base64 — traitez-le comme une boîte noire et repassez-le tel quel dans le ?next= de la requête suivante. meta.pagination.hasMore vaut true lorsqu’au moins une page supplémentaire existe.

cURL — first page

curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ/activity?limit=25"

curl \
-H "Authorization: Bearer API_KEY" \
-X GET "https://api.ayrshare.com/api/automations/auto_9xKp2Lm4nQ/activity?limit=25&next=eyJ0aW1lIjoiMjAyNi0wNS0xMlQw..."

const API_KEY = "API_KEY";
const id = "auto_9xKp2Lm4nQ";

// Paginate through every page
let next;
do {
  const url = new URL(`https://api.ayrshare.com/api/automations/${id}/activity`);
  url.searchParams.set("limit", "25");
  if (next) url.searchParams.set("next", next);

  const res = await fetch(url, {
    headers: { "Authorization": `Bearer ${API_KEY}` },
  });
  const json = await res.json();
  console.log(json.activity);
  next = json.meta?.pagination?.hasMore ? json.meta.pagination.next : undefined;
} while (next);

import requests

headers = {"Authorization": "Bearer API_KEY"}
automation_id = "auto_9xKp2Lm4nQ"

params = {"limit": 25}
while True:
    r = requests.get(
        f"https://api.ayrshare.com/api/automations/{automation_id}/activity",
        params=params,
        headers=headers,
    ).json()
    print(r["activity"])
    pagination = r.get("meta", {}).get("pagination", {})
    if not pagination.get("hasMore"):
        break
    params["next"] = pagination["next"]

$id = "auto_9xKp2Lm4nQ";
$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => "https://api.ayrshare.com/api/automations/" . $id . "/activity?limit=25",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer API_KEY"],
]);

$response = curl_exec($curl);
curl_close($curl);
echo $response;

200: Success

{
  "status": "success",
  "automationId": "auto_9xKp2Lm4nQ",
  "activity": [
    {
      "id": "auto_9xKp2Lm4nQ:trg_a1b2c3:18012345678901234",
      "automationId": "auto_9xKp2Lm4nQ",
      "triggerId": "trg_a1b2c3",
      "triggerType": "comment_keyword",
      "recipientId": "17841401234567890",
      "recipientUsername": "jane_doe",
      "eventId": "18012345678901234",
      "platform": "instagram",
      "status": "sent",
      "actionResults": [
        {
          "actionId": "act_d4e5f6",
          "type": "send_dm",
          "status": "sent",
          "completedAt": "2026-05-12T09:14:48.000Z"
        }
      ],
      "keyword": "LINK",
      "commentText": "Send me the LINK please!",
      "created": "2026-05-12T09:14:22.000Z",
      "completedAt": "2026-05-12T09:14:48.000Z"
    },
    {
      "id": "auto_9xKp2Lm4nQ:trg_a1b2c3:18012345678900000",
      "automationId": "auto_9xKp2Lm4nQ",
      "triggerId": "trg_a1b2c3",
      "triggerType": "comment_keyword",
      "recipientId": "17841409876543210",
      "recipientUsername": "repeat_user",
      "eventId": "18012345678900000",
      "platform": "instagram",
      "status": "deduplicated",
      "actionResults": [],
      "keyword": "LINK",
      "commentText": "LINK again please",
      "created": "2026-05-12T09:00:11.000Z",
      "completedAt": "2026-05-12T09:00:34.000Z"
    }
  ],
  "meta": {
    "pagination": {
      "hasMore": true,
      "limit": 25,
      "next": "eyJ0aW1lIjoiMjAyNi0wNS0xMlQwOTowMDoxMS4wMDBaIiwiaWQiOiJhdXRvXzl4S3AyTG00blE6dHJnX2ExYjJjMzoxODAxMjM0NTY3ODkwMDAwMCJ9"
    }
  }
}

{
  "status": "error",
  "message": "limit must be a positive integer"
}

{
  "status": "error",
  "message": "'previous' pagination is not supported by this endpoint"
}

{
  "action": "automation",
  "status": "error",
  "code": 469,
  "message": "Automation not found"
}