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 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 only events with a timestamp less than the specified value
You can use an ISO format date or a timestamp
Defines a sort order applied on events timestamp
By default, events are unordered and may not streamed in the same order between two requests
You should use this query parameter if you want to guarantee the sort order of events
Defines a classifications filter Specify this parameter to retrieve only events with robot classification or all hits You can use a list of string separeted with ',' for example classifications=genericrobot,mpp,gsr (mpp: Apple Mail Privacy Proxy, gsr: Google Security Robot) You should use this query parameter if you want to get the hit events classified as robot
curl -i -X GET \
'https://api-cm.np6.com/actions/{id}/events/hits/mirror?classification=string&end=2019-08-24T14%3A15%3A22Z&sort=asc&start=2019-08-24T14%3A15%3A22Z' \
-H 'X-Key: string'[ { "type": "hit", "id": "e33711c4-1c4a-4839-9027-101b8194211d", "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 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 only events with a timestamp less than the specified value
You can use an ISO format date or a timestamp
Defines a sort order applied on events timestamp
By default, events are unordered and may not streamed in the same order between two requests
You should use this query parameter if you want to guarantee the sort order of events
Defines a classifications filter Specify this parameter to retrieve only events with robot classification or all hits You can use a list of string separeted with ',' for example classifications=genericrobot,mpp,gsr (mpp: Apple Mail Privacy Proxy, gsr: Google Security Robot) You should use this query parameter if you want to get the hit events classified as robot
curl -i -X GET \
'https://api-cm.np6.com/actions/{id}/events/hits/form?classification=string&end=2019-08-24T14%3A15%3A22Z&sort=asc&start=2019-08-24T14%3A15%3A22Z' \
-H 'X-Key: string'[ { "type": "hit", "id": "47049bab-79a7-4dd4-841d-f3492fc5cf72", "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" } } } } } } ]