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?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'An array of events related to underlying activations
Publication timestamp of the event
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
[ { "type": "hit", "id": "d6d3af4e-762d-4c8b-bbe3-578ad5925f02", "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" } } } } } }, { "type": "bounce", "id": "968e9b7b-ca77-4795-9159-6e1af3566e18", "timestamp": 1614089582000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "email", "detail": { "activation": { "id": "000PE4", "kind": "message", "receiver": { "type": "id", "value": "0013KDC0" }, "stamp": { "time": 1614089576625, "id": "7bb105bd-e548-402b-bcd8-8fb30b5e6cf4", "thread": "98a5918d-b1c4-4dc6-9222-57719ccd5bc8" }, "recipient": "example@np6.com" }, "bounce": { "status": { "type": "sync", "code": { "enhanced": "5.4.4" }, "diagnostic": "unable to route: no mail hosts for domain", "mta": "" }, "analysis": { "verdict": "soft", "subject": { "type": "other or undefined status" } } } } } } ]
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/bounces?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'[ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "timestamp": 0, "identity": { "type": "string" }, "source": { "type": "string" } } ]
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?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'[ { "id": "d6d3af4e-762d-4c8b-bbe3-578ad5925f02", "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" } } } } } }, { "id": "efc4a9f5-691a-4e44-9c32-5f6d6fdcf5f9", "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" } } } } } } ]