This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.
If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.
Defines a start date filter Specify this parameter to retrieve all events related to activations that have a timestamp greater than or equal to the specified value You can use an ISO format date or a timestamp
Defines an end date filter
Specify this parameter to retrieve all events related to activations that have a timestamp less than the specified value
You can use an ISO format date or a timestamp
Defines a start date filter Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value You can use an ISO format date or a timestamp
Defines an end date filter Specify this parameter to retrieve all events related to activations that have a timestamp less than the specified value
You can use an ISO format date or a timestamp
curl -i -X GET \
'https://api-cm.np6.com/actions/reactivities/hits/open?activationEnd=2019-08-24T14%3A15%3A22Z&activationStart=2019-08-24T14%3A15%3A22Z&reactivityEnd=2019-08-24T14%3A15%3A22Z&reactivityStart=2019-08-24T14%3A15%3A22Z&sort=asc' \
-H 'X-Key: string'[ { "type": "hit", "id": "92be2be1-2ba0-4695-85bd-e3e4f55ff5c1", "timestamp": 1623673176622, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "activation": { "id": "000PE4", "kind": "message", "receiver": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" }, "stamp": { "time": 1614089576625, "id": "d52055cd-e854-4177-8ef5-b10fd8d568a7", "thread": "a3078b19-b379-4bc2-b29a-e8229a9c9332" }, "recipient": "example@np6.com" }, "link": { "type": "open", "label": "homepage", "source": "html" }, "client": { "type": "web", "ip": { "type": "v4", "value": "10.1.1.1" }, "ua": { "type": "parsed", "ua": "Mozilla/4.0 (compatible; ms-office; MSOffice 16)", "client": { "type": "Unrecognized", "name": "Microsoft Office", "vendor": "Microsoft Corporation." }, "device": { "type": "Desktop" } } } } } } ]
Defines a start date filter Specify this parameter to retrieve all events related to activations that have a timestamp greater than or equal to the specified value You can use an ISO format date or a timestamp
Defines an end date filter
Specify this parameter to retrieve all events related to activations that have a timestamp less than the specified value
You can use an ISO format date or a timestamp
Defines a start date filter Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value You can use an ISO format date or a timestamp
Defines an end date filter Specify this parameter to retrieve all events related to activations that have a timestamp less than the specified value
You can use an ISO format date or a timestamp
curl -i -X GET \
'https://api-cm.np6.com/actions/reactivities/hits/redirection?activationEnd=2019-08-24T14%3A15%3A22Z&activationStart=2019-08-24T14%3A15%3A22Z&reactivityEnd=2019-08-24T14%3A15%3A22Z&reactivityStart=2019-08-24T14%3A15%3A22Z&sort=asc' \
-H 'X-Key: string'[ { "type": "hit", "id": "f1ba144e-5b4f-4e35-9b28-ba7b9d7f722d", "timestamp": 1623673176622, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "activation": { "id": "000PE4", "kind": "message", "receiver": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" }, "stamp": { "time": 1614089576625, "id": "d52055cd-e854-4177-8ef5-b10fd8d568a7", "thread": "a3078b19-b379-4bc2-b29a-e8229a9c9332" }, "recipient": "example@np6.com" }, "link": { "type": "redirection", "label": "homepage", "source": "html", "destination": "https://www.np6.fr" }, "client": { "type": "web", "ip": { "type": "v4", "value": "10.1.1.1" }, "ua": { "type": "parsed", "ua": "Mozilla/5.0 (Linux; Android 9; AMN-LX9) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.88 Mobile Safari/537.36", "client": { "type": "Mobile browser", "name": "Chrome Mobile", "version": "91.0.4472.88", "vendor": "Google Inc." }, "os": { "name": "Android 9.0 Pie", "family": "Android", "vendor": "Google Inc." }, "device": { "type": "Smartphone", "name": "Y5 (2019)", "brand": "Huawei" } } } } } } ]
Defines a start date filter Specify this parameter to retrieve all events related to activations that have a timestamp greater than or equal to the specified value You can use an ISO format date or a timestamp
Defines an end date filter
Specify this parameter to retrieve all events related to activations that have a timestamp less than the specified value
You can use an ISO format date or a timestamp
Defines a start date filter Specify this parameter to retrieve only events with a timestamp greater than or equal to the specified value You can use an ISO format date or a timestamp
Defines an end date filter Specify this parameter to retrieve all events related to activations that have a timestamp less than the specified value
You can use an ISO format date or a timestamp
curl -i -X GET \
'https://api-cm.np6.com/actions/reactivities/hits/unsubscribe?activationEnd=2019-08-24T14%3A15%3A22Z&activationStart=2019-08-24T14%3A15%3A22Z&reactivityEnd=2019-08-24T14%3A15%3A22Z&reactivityStart=2019-08-24T14%3A15%3A22Z&sort=asc' \
-H 'X-Key: string'[ { "type": "hit", "id": "a66573b1-6002-4185-91f3-473df6ea9bb5", "timestamp": 1623673176622, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "activation": { "id": "000PE4", "kind": "message", "receiver": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" }, "stamp": { "time": 1614089576625, "id": "d868f544-2fab-4447-ae9e-32e37a1c4e89", "thread": "967b7571-3c42-4b24-8176-8ac6eaeaa643" }, "recipient": "example@np6.com" }, "link": { "type": "unsubscribe", "label": "homepage", "source": "html", "confirmation": true }, "client": { "type": "web", "ip": { "type": "v4", "value": "10.1.1.1" }, "ua": { "type": "parsed", "ua": "Mozilla/5.0 (Linux; Android 10; SM-A125F Build/QP1A.190711.020; wv) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/89.0.4389.86 Mobile Safari/537.36", "client": { "type": "Mobile browser", "name": "Android webview", "vendor": "Google Inc." }, "os": { "name": "Android 10", "family": "Android", "vendor": "Google Inc." }, "device": { "type": "Smartphone" } } } } } } ]