Sign in to fill these examples with your own keys. Sign in Start free trial

Analytics

Delivery totals for the token's team.

Delivery totals for the token's team. Optional compare returns the previous window of the same length.

GET /api/v1/teams/:obfuscated_team_id/analytics

Delivery analytics for the token's team.

  • since: ISO-8601 start. Default is 24 hours before until.
  • until: ISO-8601 end. Default is now.
  • dimension: mx_provider, sending_domain_id, tenant_id, cluster_id, sending_ip, or bounce_classification.
  • min_processed: Hide rows below this processed count. Default is 1.
  • compare: true adds a compare block for the previous window of the same length.
  • compare_since: ISO-8601 start for an explicit compare window.
  • compare_until: ISO-8601 end for an explicit compare window.
request.sh
1curl -sS -X GET \ 2 -H 'Authorization: Bearer YOUR_API_KEY' \ 3 https://app.postshiba.com/api/v1/teams/KjkAJW/analytics
response.json
1{ 2 "dimension": "mx_provider", 3 "window": { 4 "since": "2026-09-15T12:00:00Z", 5 "until": "2026-09-16T12:00:00Z" 6 }, 7 "totals": { 8 "processed": 10, 9 "delivered": 8, 10 "deferred": 1, 11 "bounce": 1, 12 "spamreport": 0, 13 "unsubscribe": 0 14 }, 15 "rows": [ 16 { 17 "key": "gmail", 18 "label": "gmail", 19 "processed": 10, 20 "delivered": 8, 21 "deferred": 1, 22 "bounce": 1, 23 "spamreport": 0, 24 "unsubscribe": 0 25 } 26 ] 27}