Obter activity da automação

Log de auditoria paginado por cursor para uma automação

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

Beta. Consulte a visão geral de Automations para a descrição completa do recurso.

Retorna cada tentativa de despacho de uma automação, começando pela mais recente. Cada linha registra o destinatário, o trigger correspondente, o resultado de cada action e qualquer erro.

Linhas dos últimos 30 dias são retornadas. Linhas mais antigas existem no Firestore (a retenção é indefinida para análises) mas são excluídas deste endpoint por questões de desempenho.

​

Status da linha de activity

Cada linha tem um status de nível superior mais um status por action dentro de actionResults[].

Status	Quando é registrado
pending	Linha recém-gravada; o worker ainda não a pegou
in_flight	O worker está despachando no momento
sent	Todas as actions foram bem-sucedidas
failed	Pelo menos uma action falhou (e nenhuma teve erro de autenticação)
auth_error	O access token do Instagram era inválido; a DM não foi reenviada
rate_limited	O cap diário de DMs (por tier ou por perfil) foi atingido. Nenhuma DM foi enviada
deduplicated	Esta action já foi disparada para este destinatário dentro da sua janela de dedup (padrão de 7 dias, configurável por action)
skipped	A automação ficou inativa ou foi excluída entre o fan-out e o despacho

pending e in_flight são transitórios; todos os outros são terminais.

​

Parâmetros de cabeçalho

​

Parâmetros de caminho

id · string · obrigatório

O ID da automação retornado por POST /automations.

​

Parâmetros de query

limit · number · padrão: 25

Tamanho da página. Padrão 25, máximo 100. Valores fora de [1, 100] são ajustados; valores não inteiros ou ≤0 retornam HTTP 400.

next · string

Cursor opaco de um meta.pagination.next de uma resposta anterior. Omita na primeira requisição.

Somente avanço — passar ?previous= retorna HTTP 400.

​

Formato da resposta

A resposta envolve a lista de resultados em activity[] e as informações do cursor em meta.pagination:

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

meta.pagination.next é um blob opaco codificado em base64 — trate-o como uma caixa preta e passe-o inalterado no ?next= da próxima requisição. meta.pagination.hasMore é true quando existe pelo menos mais uma página.

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