Skip to main content

List Instance Activity Log

GET 
/api/integrations/17track/instances/:instance/activity

Paginated activity log entries for one 17TRACK integration instance: entries about the instance itself (connect, settings update, disconnect) and entries recorded for it by background work (registration, polling, webhooks, backfill, quota alerts). Entries from background work have a null causer; actions a user triggered carry that user.

Not yet available to API tokens

This endpoint currently requires session authentication; Personal Access Token scope support is in progress.

Filters (filter[...]):

  • event_type — comma-separated event names
  • causer_id — comma-separated user IDs
  • search — contains match on description
  • description, event — text filters; the bare key is an exact match, and filter[<field>.<operator>] takes any of contains, does_not_contain, is, is_not, is_one_of, is_not_one_of, starts_with, does_not_start_with, ends_with, does_not_end_with, is_empty, is_not_empty
  • created_at — date filter, filter[created_at.<operator>] with is, is_not, before, after, on_or_before, on_or_after, between, is_empty, is_not_empty, today, yesterday, past_week, past_month, past_year, past_days, days_ago, .... Dates are Y-m-d in the account timezone; between takes two comma-separated dates.

filter_groups accepts a base64-encoded JSON filter tree for AND/OR combinations: {"conjunction": "and", "children": [{"type": "condition", "condition": {"column": "<field>.<operator>", "operator": "<operator>", "value": "..."}}, {"type": "group", "group": {"conjunction": "or", "children": [...]}}]}. When it is present it takes precedence over the flat filter[...] parameters.

Unknown filter names are rejected with 400 Bad Request.

Allowed sorts: created_at, event, id (default: -created_at, -id).

Event names recorded by the 17TRACK integration:

  • connected, updated (with properties.changed_keys), disconnected — instance lifecycle
  • register_completed, register_failed, register_rate_limited — registering tracking numbers with 17TRACK
  • poll_completed, poll_rate_limited, poll_quota_exceeded — scheduled or manual syncs
  • stop_completed, stop_failed — stopping tracking for finished shipments
  • manual_push_triggered, manual_refresh_triggered — Push Pending Tracking Numbers / Pull Tracking Updates
  • retrack_completed, carrier_changed, tracking_renumbered — per-tracking corrections
  • backfill_started, backfill_completed — historical backfill
  • webhook_processed, webhook_failed — inbound webhooks
  • quota_exceeded, quota_threshold_alerted, stalled_shipments_alerted — alerts

Responses:

  • 200 OK — paginated activity rows
  • 400 Bad Request — a filter name that is not allowed
  • 404 Not Found — instance id does not exist

Authentication: Bearer token (Personal Access Token).

Request​

Responses​

OK

Response Headers
    Content-Type