Analytics

Analytics overview

get

Client-scoped analytics summary for a time window: order totals with a by-status breakdown, results in vs. still missing, and webhook failures with a daily series.

Authorizations

AuthorizationstringRequired

Authenticate with your Terra API credentials: username = your Terra dev-id, password = your Terra API key — the same credentials used for every other Terra API. The header pair dev-id + x-api-key is also accepted. Suspended credentials receive 403; accounts without the Vantage entitlement receive 403 once entitlement enforcement is enabled.

Query parameters

sincestring · date-timeOptional

Start of the window (RFC3339). Defaults to until minus 7 days.

untilstring · date-timeOptional

End of the window (RFC3339). Defaults to now.

Responses

200

Analytics summary

application/json

400

Invalid time window

application/json

401

Missing or invalid credentials

application/json

500

Internal server error

application/json

get/api/v1/overview

GET /api/v1/overview HTTP/1.1
Host: vantage.tryterra.co
Authorization: Basic username:password
Accept: */*

{
  "orders": {
    "total": 27,
    "by_status": {
      "order.completed": 29,
      "order.processing": 8
    }
  },
  "results": {
    "total": 7,
    "missing": 8
  },
  "webhooks": {
    "failed_total": 5,
    "daily": [
      {
        "date": "2026-05-16",
        "failed": 1
      }
    ]
  }
}

List webhook delivery outcomes

get

Client-scoped keyset list of terminal webhook delivery outcomes, newest first. Use outcome=failed to see only permanently-failed deliveries.

Authorizations

AuthorizationstringRequired

Authenticate with your Terra API credentials: username = your Terra dev-id, password = your Terra API key — the same credentials used for every other Terra API. The header pair dev-id + x-api-key is also accepted. Suspended credentials receive 403; accounts without the Vantage entitlement receive 403 once entitlement enforcement is enabled.

Query parameters

outcomestring · enumOptional

One delivery outcome, or "failed" (rejected|invalid|dead_lettered).

Possible values:

limitinteger · min: 1 · max: 100OptionalDefault: 25

cursorstringOptional

event_id from the previous page's next_cursor

Example: 333410942627700737

Responses

200

One page of delivery outcomes

application/json

next_cursorstringOptional

Pass as ?cursor= for the next page; absent on the last page.

Example: 333410942627700737

400

Invalid pagination or filter parameters

application/json

401

Missing or invalid credentials

application/json

500

Internal server error

application/json

get/api/v1/webhook-deliveries

GET /api/v1/webhook-deliveries HTTP/1.1
Host: vantage.tryterra.co
Authorization: Basic username:password
Accept: */*

{
  "deliveries": [
    {
      "event_id": "333410942627700737",
      "event_type": "order_item.results_status_change",
      "order_id": "333410942627700736",
      "order_item_id": "333410942627700737",
      "outcome": "dead_lettered",
      "final_status_code": 500,
      "attempts": 6,
      "completed_at": "2026-01-01T00:00:00.000Z",
      "event_created_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "next_cursor": "333410942627700737"
}