Retrieve events of the specified campaign items

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

endstring(date-time)

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

sortstring

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

Enum"asc""desc"

Headers

X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/json

itemsEventsArray of objects

The events type /subtype and items per channel

typestring

Discriminator

eventsArray of objects

Event's type

itemsArray of integers(int32)

Items

curl -i -X POST \
  'https://api-cm.np6.com/campaigns/{id}/events?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z&sort=asc' \
  -H 'Content-Type: application/json' \
  -H 'X-Key: string' \
  -d '{
    "itemsEvents": [
      {
        "type": "email",
        "events": [
          {
            "type": "hit",
            "subtypes": [
              "open",
              "form",
              "unsubscribe",
              "redirection",
              "mirror"
            ]
          }
        ],
        "items": [
          "actionId1",
          "actionId2"
        ]
      }
    ]
  }'

Responses

An array of events

Bodyapplication/jsonArray [

typestring

Discriminator

idstring(uuid)

Uuid of the event

timestampinteger(int64)

Publication timestamp of the event
This is the number of milliseconds elapsed since January 1, 1970 00:00:00 UTC.

identityobject

Underlying identity of the event

typestring

Discriminator

sourceobject

Source of the event

typestring

Discriminator

detailobject

Detail of the execution

]

Response

application/json

[
  {
    "type": "execution",
    "id": "b794a047-b15a-498c-9e46-8762d009bfb1",
    "timestamp": 1614089576718,
    "identity": {
      "type": "customer",
      "agency": "DEMO",
      "customer": "028"
    },
    "source": {
      "type": "email",
      "detail": {
        "execution": {
          "id": "000PE4",
          "kind": "message",
          "recipient": {
            "type": "footprint",
            "id": "000R4M0T",
            "unicity": "example@np6.com",
            "hash": "0441619ab4631d18548aa8835dd2c28b"
          },
          "data": {
            "foo": 1,
            "bar": 2
          },
          "stamp": {
            "time": 1614089576625,
            "id": "340adff4-c193-427e-9e14-6a27633b77f6",
            "thread": "73b43cda-527a-4de7-911a-b4550dabc571"
          }
        }
      }
    }
  },
  {
    "type": "activation",
    "id": "d436cfcb-8dda-4b12-a174-bf6519b50dd1",
    "timestamp": 1614089582000,
    "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"
        }
      }
    }
  },
  {
    "type": "hit",
    "id": "5cb5d7c1-70d4-421a-a850-73b0728e1684",
    "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"
            }
          }
        }
      }
    }
  }
]