Get sent emails report | Close | Developer API Documentation

curl https://api.close.com/api/v1/report/sent_emails/org_id/ \
     -u "<CLOSE_API_KEY>:"

{
  "sent_email_stats": [
    {
      "_queries": {
        "opened": "email(direction:sent opened:yes)",
        "responded": "email(direction:sent has_reply:yes)",
        "total": "email(direction:sent)"
      },
      "is_shared": true,
      "name": "All Emails",
      "opened": 3474546,
      "percentage_opened": 21,
      "percentage_responded": 10,
      "responded": 348741,
      "template_id": null,
      "template_url": null,
      "total": 735434
    },
    {
      "_queries": {
        "opened": "email(direction:sent template:\"Promo Email\" opened:yes)",
        "responded": "email(direction:sent template:\"Promo Email\" has_reply:yes)",
        "total": "email(direction:sent template:\"Promo Email\")"
      },
      "is_shared": true,
      "name": "Promo Email",
      "opened": 40,
      "percentage_opened": 40,
      "percentage_responded": 9,
      "responded": 9,
      "template_id": "tmpl_vB0Ql8Npgkq84jly82lqFn331D2tFfA2QXcRUvzcCOt",
      "template_url": "/organization/orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH/email_templates/tmpl_vB0Ql8Npgkq84jly82lqFn331D2tFfA2QXcRUvzcCOt/",
      "total": 101
    }
  ]
}

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

org_idstringRequired

Query parameters

date_startstringOptional

date_endstringOptional

user_idstringOptional

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error