Returns a page of detailed conversions.
1 |
GET https://api.maileon.com/1.0/reports/analytics/conversions |
1 |
GET https://api.maileon.com/1.0/reports/analytics/conversions/count |
Attributes
Parameter | Default | Description |
from_date | If provided, only the conversions after or equal (including) the given date will be returned. The value of from_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00 | |
to_date | If provided, only the conversions before (excluding) the given date will be returned. The value of to_date must be a numeric value representing a point in time milliseconds after January 1, 1970 00:00:00 | |
mailing_id | Multivalued parameter to filter the conversions by mailings. Each value must correspond to a mailing id. | |
ids | Multivalued parameter to filter the conversions by contacts. Each value must correspond to a contact id. | |
emails | Multivalued parameter to filter the conversions by email addresses. | |
eids | Multivalued parameter to filter the conversions by external ids. Each value must correspond to a contacts external id | |
site_ids | Multivalued parameter to filter the conversions by site ids. Each value must correspond to a valid site id. | |
goal_ids | Multivalued parameter to filter the conversions by goal ids. Each value must correspond to a valid goal id. | |
link_ids | Multivalued parameter to filter the conversions by link ids. Each value must correspond to a valid link id. | |
page_index | 1 | The index of the result page. The index must be greater or equal to 1. |
page_size | 100 | The maximum count of items in the result page. If provided, the value of page_size must be in the range 1 to 1000. |
Example
1 2 |
GET https://api.maileon.com/1.0/reports/analytics/conversions?page_index=1&page_size=500 Authorization: Basic XXXXXXXXXXXXXXX |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 |
Status: 200 OK Content-Type: application/vnd.maileon.api+xml link: ... x-pages: ... x-items: ... <conversions> <conversion> <contact_id>5</contact_id> <contact_email>max.mustermann@xqueue.com</contact_email> <contact_external_id nil="true"></contact_external_id> <value>10.0</value> <mailing_sent_date>1533913505000</mailing_sent_date> <mailing_sent_date_sql>2018-08-10 17:05:05</mailing_sent_date_sql> <mailing_id>12</mailing_id> <mailing_name>New Arrivals 10/18</mailing_name> <site_id>1218</site_id> <site_name>Shop</site_name> <goal_id>9</goal_id> <goal_name>Sale Pageview</goal_name> <link_id>1</link_id> <link_url>http://www.xqueue.de/shop/...</link_url> <timestamp>1533915191000</timestamp> <timestamp_sql>2018-08-10 17:33:11</timestamp_sql> </conversion> <conversion> <contact_id>5</contact_id> <contact_email>max.mustermann@xqueue.com</contact_email> <contact_external_id nil="true"></contact_external_id> <value>132.90</value> <mailing_sent_date>1533913505000</mailing_sent_date> <mailing_sent_date_sql>2018-08-10 17:05:05</mailing_sent_date_sql> <mailing_id>12</mailing_id> <mailing_name>New Arrivals 10/18< </mailing_name> <site_id>1218</site_id> <site_name>Shop</site_name> <goal_id>9</goal_id> <goal_name>Sale Pageview</goal_name> <link_id>1</link_id> <link_url>http://www.xqueue.de/shop/...</link_url> <timestamp>1533915199000</timestamp> <timestamp_sql>2018-08-10 17:33:19</timestamp_sql> </conversion> </conversions> |