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
- Retrieve form "hit" reactivities of all marketing actions
NP6 API Reference (8.1.0)
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 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
- Production serverhttps://api-cm.np6.com/actions/reactivities/hits/mirror
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/actions/reactivities/hits/mirror?activationStart=2019-08-24T14%3A15%3A22Z&activationEnd=2019-08-24T14%3A15%3A22Z&reactivityStart=2019-08-24T14%3A15%3A22Z&reactivityEnd=2019-08-24T14%3A15%3A22Z&sort=asc' \
-H 'X-Key: string'[ { "type": "hit", "id": "08531d18-152f-4337-892c-3fc967b65082", "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": "b967f2f1-2c49-4592-8027-77504af1cc7e", "thread": "e8c56c7f-66b7-4787-bdb3-59611efeebeb" }, "recipient": "example@np6.com" }, "link": { "type": "mirror", "label": "mirror page", "source": "html" }, "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" } } } } } } ]
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
- Production serverhttps://api-cm.np6.com/actions/reactivities/hits/form
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/actions/reactivities/hits/form?activationStart=2019-08-24T14%3A15%3A22Z&activationEnd=2019-08-24T14%3A15%3A22Z&reactivityStart=2019-08-24T14%3A15%3A22Z&reactivityEnd=2019-08-24T14%3A15%3A22Z&sort=asc' \
-H 'X-Key: string'[ { "type": "hit", "id": "ec2d644a-f16c-4f1c-8e69-ceab0d1dd043", "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": "007a1274-0952-42f8-a85b-1230352c8d2b", "thread": "feed3692-1b39-46fc-91be-8ae827cace32" }, "recipient": "example@np6.com" }, "link": { "type": "form", "label": "start", "source": "html", "value": "0000F1" }, "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" } } } } } } ]
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
- Production serverhttps://api-cm.np6.com/actions/{id}/reactivities
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/actions/{id}/reactivities?activationStart=2019-08-24T14%3A15%3A22Z&activationEnd=2019-08-24T14%3A15%3A22Z&reactivityStart=2019-08-24T14%3A15%3A22Z&reactivityEnd=2019-08-24T14%3A15%3A22Z&sort=asc' \
-H 'X-Key: string'An array of events related to underlying activations
- execution
- cancellation
- activation
- bounce
- hit
- creation
- modification
- impression
- suppression
- optout
- reply
- complaint
Publication timestamp of the event
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.
Source of the event
[ { "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" } } } } } }, { "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" } } } } } } ]