GET
https://www.app.ocoya.com/api/_public/v1/email/{emailId}/stats
Get email stats
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/email/{emailId}/stats \
  --header 'X-API-Key: <api-key>'
{
  "emailId": "<string>",
  "summary": {
    "recipients": 123,
    "sent": 123,
    "delivered": 123,
    "opened": 123,
    "clicked": 123,
    "bounced": 123,
    "complained": 123,
    "unsubscribed": 123,
    "failed": 123,
    "queued": 123,
    "openRate": 123,
    "clickRate": 123
  },
  "links": [
    {
      "url": "<string>",
      "clicks": 123,
      "people": 123
    }
  ],
  "timeline": [
    {
      "hour": "<string>",
      "opens": 123,
      "clicks": 123
    }
  ]
}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Path Parameters

emailIdstringrequired

Ocoya email ID, from GET /email.

Example:"cmwdkjtfh005gy0k4ggzzg1bs"

Response

application/json

Success

emailIdstring
summaryobject

Results, worked out from its sends.

Show child attributesHide child attributes
summary.recipientsinteger
summary.sentinteger
summary.deliveredinteger
summary.openedinteger
summary.clickedinteger
summary.bouncedinteger
summary.complainedinteger
summary.unsubscribedinteger
summary.failedinteger
summary.queuedinteger
summary.openRatenumber

Percent of delivered.

summary.clickRatenumber

Percent of delivered.

Show child attributesHide child attributes
timelineobject[]
Show child attributesHide child attributes
timeline.hourstring
timeline.opensinteger
timeline.clicksinteger