Skip to content
Pidgely Docs

API reference · Automations

Summarize a store's automations

GEThttps://api.pidgely.com/automations/summary
View as Markdown

How many automations a store has, how many are active, and their counters over the last 30 days.

The automations of a store and their counters over the last 30 days (the store page card). Needs a plan with automations (Scale or custom; 403 plan_required otherwise).

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

Query parameters

Name Type Required Description
store_id string Yes UUID.

Request

This endpoint is not in the SDKs yet; call it over HTTP.

cURL
curl -X GET 'https://api.pidgely.com/automations/summary?store_id=0199e0f2-1a2b-7c3d-9e4f-5a6b7c8d9e01' \
  -H "Authorization: Bearer $PIDGELY_API_KEY"

Response

200 OK

JSON
{
  "object": "automation_summary",
  "available": true,
  "automations": 2,
  "active": 2,
  "currency": "BRL",
  "last_30_days": {
    "enrolled": 412,
    "active": 57,
    "sent": 374,
    "skipped": 2,
    "opened": 198,
    "clicked": 73,
    "exited_goal": 34,
    "exited_other": 7,
    "conversions": 34,
    "revenue": 811190
  }
}

Response fields

Name Type Required Description
object string Yes Object type. One of automation_summary.
available boolean Yes —
automations integer Yes —
active integer Yes —
currency string Yes —
last_30_days object Yes Counters over a period: customers enrolled, live (active: active or held now), e-mails sent and skipped, unique opens and clicks (tracked domains), exits by goal (an order, a payment) and for other reasons, conversions and recovered revenue (minor units of the store currency).
last_30_days.enrolled integer Yes —
last_30_days.active integer Yes —
last_30_days.sent integer Yes —
last_30_days.skipped integer Yes —
last_30_days.opened integer Yes —
last_30_days.clicked integer Yes —
last_30_days.exited_goal integer Yes —
last_30_days.exited_other integer Yes —
last_30_days.conversions integer Yes —
last_30_days.revenue integer Yes Format: int64.

Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.

Status Name When
401 missing_api_key, restricted_api_key No Authorization: Bearer header, or a sending_access key called an endpoint that needs full_access.
403 invalid_api_key, validation_error The API key is invalid or revoked, or the request is not allowed for this account (unverified domain, plan limit, paused account).
404 not_found The resource does not exist in this account (or the id is not a valid UUID).
422 validation_error A field is missing or invalid; message names it.
429 rate_limit_exceeded Too many requests per second. Wait for Retry-After seconds.
403 plan_required The organization is below the Scale plan (field is automations).