Statistics¶
-
GET
/api/v1/statistics/opens
¶ List all opens statistics
Query Parameters: - campaign (int) – filter results by campaign’s unique identifier
- mailing (int) – filter results by mailing‘s unique identifier
- unique (boolean) – aggregate the opens by delivery
- date (date) – filter results by date
- from_datetime (datetime) – filter out results with a more recent datetime
- to_datetime (datetime) – filter out results with a less recent datetime
Response JSON Object: - mailing (int) – the open’s mailing
- email (email) – the open’s email
- datetime (datetime) – the open’s datetime
Request:
GET /api/v1/statistics/opens HTTP/1.1 Host: account.emailicious.com Accept: application/json
Response:
HTTP/1.1 200 OK Vary: Accept Allow: GET, HEAD, OPTIONS Content-Type: application/json { "count": 1, "next": null, "previous": null, "results": [ { "mailing": 1, "email": "foo@bar.org", "datetime": "2014-06-06T20:56:57Z" } ] }
-
GET
/api/v1/statistics/clicks
¶ List all clicks statistics
Query Parameters: - campaign (int) – filter results by campaign’s unique identifier
- mailing (int) – filter results by mailing‘s unique identifier
- unique (boolean) – aggregate the clicks by delivery
- date (date) – filter results by date
- from_datetime (datetime) – filter out results with a more recent datetime
- to_datetime (datetime) – filter out results with a less recent datetime
- url (url) – filter results by link URL
Response JSON Object: - mailing (int) – the click’s mailing
- email (email) – the click’s email
- datetime (datetime) – the click’s datetime
- url (url) – the click’s link URL
Request:
GET /api/v1/statistics/clicks HTTP/1.1 Host: account.emailicious.com Accept: application/json
Response:
HTTP/1.1 200 OK Vary: Accept Allow: GET, HEAD, OPTIONS Content-Type: application/json { "count": 1, "next": null, "previous": null, "results": [ { "mailing": 1, "email": "foo@bar.org", "datetime": "2014-06-06T20:56:57Z", "url": "https://example.com" } ] }
-
GET
/api/v1/statistics/bounces
¶ List all bounces statistics
Query Parameters: - campaign (int) – filter results by campaign’s unique identifier
- mailing (int) – filter results by mailing‘s unique identifier
- unique (boolean) – aggregate the bounces by delivery
- date (date) – filter results by date
- from_datetime (datetime) – filter out results with a more recent datetime
- to_datetime (datetime) – filter out results with a less recent datetime
- hard (boolean) – filter result by bounce permanent status
Response JSON Object: - mailing (int) – the bounce’s mailing
- email (email) – the bounce’s email
- datetime (datetime) – the bounce’s datetime
- hard (boolean) – the bounce’s permanent status
Request:
GET /api/v1/statistics/bounces HTTP/1.1 Host: account.emailicious.com Accept: application/json
Response:
HTTP/1.1 200 OK Vary: Accept Allow: GET, HEAD, OPTIONS Content-Type: application/json { "count": 1, "next": null, "previous": null, "results": [ { "mailing": 1, "email": "foo@bar.org", "datetime": "2014-06-06T20:56:57Z", "hard": false } ] }