Operational analytics: volume, error rate, throughput trend, and document…

Analytics report

GET /v1/analytics

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/analytics' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

{
  "accepted": 1,
  "by_day": [
    {
      "count": 2,
      "date": "2026-08-31T14:22:05Z"
    }
  ],
  "by_partner": [
    {
      "accepted": 1,
      "error_rate": 8,
      "inbound": 1,
      "outbound": 1,
      "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "rejected": 1,
      "total": 102
    }
  ],
  "by_transaction_set": [
    {
      "count": 2,
      "transaction_set": "string"
    }
  ],
  "cycle_time": {
    "max_hours": 1,
    "median_hours": 1,
    "metric": "string",
    "p95_hours": 1,
    "references_measured": 1
  },
  "error_rate": 8,
  "inbound": 1,
  "outbound": 1,
  "rejected": 1,
  "total_documents": 1
}

Response

AnalyticsReport

accepted · integer · required

Minimum: 0.

by_day · DayVolume[] · required

Show DayVolume

count · integer · required

Minimum: 0.

date · string · required

by_partner · PartnerVolume[] · required

Show PartnerVolume

accepted · integer · required

Minimum: 0.

error_rate · integer,null (int32)

Rejected ÷ (accepted + rejected), percent 0–100. None if none decided. Minimum: 0.

inbound · integer · required

Minimum: 0.

outbound · integer · required

Minimum: 0.

partner_id · string · required

rejected · integer · required

Minimum: 0.

total · integer · required

Minimum: 0.

by_transaction_set · SetVolume[] · required

Show SetVolume

count · integer · required

Minimum: 0.

transaction_set · string · required

cycle_time · CycleTime · required

Document activity span across references that span multiple documents.

Show CycleTime

max_hours · integer,null (int64)

median_hours · integer,null (int64)

metric · string · required

Stable metric name. This is not payment settlement or order-to-cash time.

p95_hours · integer,null (int64)

references_measured · integer · required

References with at least two documents (an order and a downstream doc). Minimum: 0.

error_rate · integer,null (int32)

Overall error rate, percent 0–100. Minimum: 0.

inbound · integer · required

Minimum: 0.

outbound · integer · required

Minimum: 0.

rejected · integer · required

Minimum: 0.

total_documents · integer · required

Minimum: 0.

Status codes

Code	Meaning
200	Analytics report
403	Admin credential required

Using this contract

Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.

cURL

curl --silent --show-error --fail-with-body --request GET \
  --url 'https://api.edi.stateset.com/v1/analytics' \
  --header "Authorization: Bearer $EDI_API_TOKEN"

200

{
  "accepted": 1,
  "by_day": [
    {
      "count": 2,
      "date": "2026-08-31T14:22:05Z"
    }
  ],
  "by_partner": [
    {
      "accepted": 1,
      "error_rate": 8,
      "inbound": 1,
      "outbound": 1,
      "partner_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "rejected": 1,
      "total": 102
    }
  ],
  "by_transaction_set": [
    {
      "count": 2,
      "transaction_set": "string"
    }
  ],
  "cycle_time": {
    "max_hours": 1,
    "median_hours": 1,
    "metric": "string",
    "p95_hours": 1,
    "references_measured": 1
  },
  "error_rate": 8,
  "inbound": 1,
  "outbound": 1,
  "rejected": 1,
  "total_documents": 1
}