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 "optout" reactivities of all notifications
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/notifications/reactivities/hits
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/notifications/reactivities/hits?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 hit 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": "hit", "id": "14d3d192-bd40-4c0b-9048-4469ab3a981c", "timestamp": 1614089593000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "notification", "detail": { "activation": { "id": 156, "version": "ecce4585-1627-4495-90fc-7bbc27d2ae26", "kind": "application", "receiver": { "type": "contact", "value": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" } }, "application": "076db4f8-4304-4b8e-b232-4820f2639a8a", "subscription": "65b51edb-0cc2-4fed-a6d0-2aa5a722d39a", "stamp": { "time": 1614089576625, "id": "d52055cd-e854-4177-8ef5-b10fd8d568a7", "thread": "a3078b19-b379-4bc2-b29a-e8229a9c9332" }, "channel": "notification_channel", "urgent": true, "expiration": "0001-01-01T00:00:00Z" }, "link": { "type": "redirection", "label": null, "uri": "deeplink://product?id=594" } } } } ]
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/notifications/reactivities/optouts
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/notifications/reactivities/optouts?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 hit 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": "optout", "id": "14d3d192-bd40-4c0b-9048-4469ab3a981c", "timestamp": 1614089593000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "notification", "detail": { "activation": { "id": 156, "version": "3c74d8f9-b9e9-4864-b3fb-c97f57d7a80f", "kind": "application", "receiver": { "type": "contact", "value": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" } }, "application": "798691ae-6a59-45f8-bff4-d7405bdab850", "subscription": "05b327b3-274c-47ab-bc73-0879a302c241", "stamp": { "time": 1614089576625, "id": "d52055cd-e854-4177-8ef5-b10fd8d568a7", "thread": "a3078b19-b379-4bc2-b29a-e8229a9c9332" }, "channel": "notification_channel", "urgent": true, "expiration": "0001-01-01T00:00:00Z" }, "optout": { "type": "channel", "channel": "channel" } } } } ]
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/notifications/reactivities/bounces
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api-cm.np6.com/notifications/reactivities/bounces?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 hit 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": "14d3d192-bd40-4c0b-9048-4469ab3a981c", "timestamp": 1614089593000, "identity": { "type": "customer", "agency": "DEMO", "customer": "028" }, "source": { "type": "notification", "detail": { "activation": { "id": 156, "version": "8cffe119-dd55-4548-bac9-fea5e47f83aa", "kind": "application", "receiver": { "type": "contact", "value": { "type": "footprint", "id": "000R4M0T", "unicity": "example@np6.com", "hash": "0441619ab4631d18548aa8835dd2c28b" } }, "application": "5968b344-0e10-4b41-94ea-8385fad7f866", "subscription": "1912df6e-743e-47e8-ad54-010d37e4b0d5", "stamp": { "time": 1614089576625, "id": "d52055cd-e854-4177-8ef5-b10fd8d568a7", "thread": "a3078b19-b379-4bc2-b29a-e8229a9c9332" }, "channel": "notification_channel", "urgent": true, "expiration": "0001-01-01T00:00:00Z" }, "bounce": { "status": null, "analysis": { "verdict": "hard", "subject": { "type": "token", "detail": { "type": "unregistered" } } } } } } } ]