Event tracking

Events

Name	Groups	Resource type	Metadata	Description
BOOKING_TEMPLATE_CREATED		booking-template	example	After BookingTemplate created
CAMPAIGN_CREATED		campaign	example	After Campaign created
CAMPAIGN_DELIVERY_REPORT_CREATED		campaign	example	After CampaignDeliveryReport created
CAMPAIGN_DELIVERY_REPORT_UPDATED		campaign	example	After CampaignDeliveryReport updated
CAMPAIGN_ORDER_STATUS_CHANGED		campaign	example	After Campaign updated order status
CAMPAIGN_SYNCHRONIZATION_CHANGELOG		campaign	example	Handling changelog in Campaign synchronization
CAMPAIGN_SYNCHRONIZATION_ERROR		campaign	example	Campaign synchronization went wrong
CAMPAIGN_SYNCHRONIZATION_FINISHED		campaign	example	Campaign synchronization finished, CampaignSynchronization marked status as `synchronized`
CAMPAIGN_SYNCHRONIZATION_INITIALIZED		campaign	example	Manual campaign synchronization initialization, CampaignSynchronization marked status as `inProgress`
CAMPAIGN_SYNCHRONIZATION_INITIALIZED_AUTOMATICALLY		campaign	example	Campaign synchronization automatically initialization, CampaignSynchronization marked status as `inProgress`
CAMPAIGN_SYNCHRONIZATION_REMOVE_RESOURCE		campaign	example	Handling ResourceDeleteResponse, after CampaignSynchronization removed
CAMPAIGN_SYNCHRONIZATION_REMOVE_RESOURCE_ERROR		campaign	example	Handling ResourceDeleteErrorResponse with errors, after CampaignSynchronization removed
CAMPAIGN_SYNCHRONIZATION_SELECTED_INITIALIZED		campaign	example	Manual campaign synchronization initialization with selected Campaigns/Targets, CampaignSynchronization marked status as `inProgress`
CAMPAIGN_SYNCHRONIZATION_WARNING		campaign	example	Handling WarningResponse in Campaign synchronization, CampaignSynchronization marked status as `syncError`
CAMPAIGN_UPDATED	reservations	campaign	example	After Campaign changed
COMPENSATED_CAMPAIGN	reservations	campaign	example	After Campaign created if type is `compensation`
COMPENSATION_CAMPAIGN	reservations	campaign	example	After Campaign created if type is `compensation`
CUSTOMER_SYNCHRONIZATION_CHANGELOG		customer	entityId example	Handling changelog in non Campaign/CreativeReservation synchronization
EMAIL_SENT			example	After sent e-mail successfully
INVITATION_USER_CREATED	users	user	example	After Self-Serve User has been created from invitation
RESERVATION_CPC_STOP	reservations	campaign	campaign.id reservation.id example	After CPC Reservation has been stopped
RESERVATION_CREATED	reservations	campaign	campaign.id reservation.id example	After Reservation was created
RESERVATION_DELETED	reservations	campaign	campaign.id reservation.id example	After Reservation removed, marked status as `deleted`
RESERVATION_DONE	reservations	campaign	campaign.id reservation.id example	Before Reservation marked traffic status as `done`
RESERVATION_EXTENDED		campaign	campaign.id reservation.id example	After Reservation extended expiration date
RESERVATION_EXTENDED_BY_ADMIN		campaign	campaign.id reservation.id example	After Reservation extended expiration date, action available only for admin users
RESERVATION_FINISHED	reservations	campaign	campaign.id reservation.id example	Before sent e-mail about reservations which exceeded end date
RESERVATION_GUARANTEED_CREDIT_CARD_STOP	reservations	campaign	campaign.id reservation.id example	After guaranteed credit-card Reservation has been canceled
RESERVATION_INVOICED		campaign	reservation.id example	After Reservation marked status as `invoiced` or `sold_invoiced`
RESERVATION_IN_PROGRESS	reservations	campaign	campaign.id reservation.id example	Before Reservation marked traffic status as `in-progress`
RESERVATION_ITEM_CREATED		campaign	campaign.id placement.id reservationItem.id example	After ReservationItem is created
RESERVATION_ITEM_DONE		campaign	campaign.id placement.id reservationItem.id example	After ReservationItem marked `isDone`
RESERVATION_ITEM_INVOICED	reservations	campaign	campaign.id placement.id reservationItem.id example	After ReservationItem marked status from `sold` to `invoiced`
RESERVATION_ITEM_SOLD		campaign	campaign.id placement.id reservationItem.id example	After ReservationItem marked status as `sold`
RESERVATION_ITEM_UNDONE	reservations	campaign	campaign.id placement.id reservationItem.id example	After ReservationItem unmarked `isDone`
RESERVATION_LIVE	reservations	campaign	campaign.id reservation.id example	After Reservation is live (startDate <= now()), triggered once per reservation
RESERVATION_MOVE_FROM	reservations	campaign	campaign.id reservation.id fromCampaign.id example	After moving Reservation from Campaign
RESERVATION_MOVE_TO	reservations	campaign	campaign.id reservation.id toCampaign.id example	Before moving Reservation to Campaign
RESERVATION_NON_GUARANTEED_CREDIT_CARD_STOP	reservations	campaign	campaign.id reservation.id example	After non-guaranteed credit-card Reservation has been stopped
RESERVATION_ORDER_STATUS_CHANGED		campaign	example	After Reservation updated order status
RESERVATION_OPEN	reservations	campaign	campaign.id reservation.id example	Before Reservation marked traffic status as `open`
RESERVATION_PROLONGED	reservations	campaign	campaign.id reservation.id example	After a no-end date Reservation gets prolonged
RESERVATION_SOLD		campaign	campaign.id reservation.id example	After Reservation marked status as `sold`
RESERVATION_STOP	reservations	campaign	campaign.id reservation.id example	After Reservation has been stopped
RESERVATION_UNDONE	reservations	campaign	campaign.id reservation.id example	After Reservation unmarked `isDone` traffic status
RESERVATION_UPDATE	reservations	campaign	campaign.id reservation.id example	After Reservation changed
RESERVATION_UPDATE_DISCOUNT	reservations	campaign	campaign.id reservation.id example	After Reservation and ReservationItemPeriod `discountedPrice` changed
SELF_SERVE_USER_CREATED	users	user	example	After Self-Serve User has been created
SELF_SERVE_USER_DELETED	users	user	example	After Self-Serve User has been deleted
SELF_SERVE_USER_LOGGED_IN	users	user	example	After Self-Serve User has logged in
SELF_SERVE_USER_UPDATED	users	user	example	After Self-Serve User has been updated

More detailed metadata can be found on page Metadata examples.

Pagination

This endpoint uses pagination Has More, but requires a parameter eventId instead of lastId.

Examples

Introduction

Headers X-RoseApiAuth-PublicKey and X-RoseApiAuth-AccessToken are required. Endpoint can return only 1000 records at once. Parameters in examples aren't encoded for better readability.

Request

No filters

Get records without filtering

/v1/event-tracking

eventId

Get records after a specified eventId. A specified event isn't included.

/v1/event-tracking?eventId=1

date

Get records for a specified date. Required format YYYY-MM-DD.

/v1/event-tracking?date=2020-01-01

events

Get records for specified operations. Full list of operations in Events table.

/v1/event-tracking?events[]=CAMPAIGN_CREATED&events[]=CAMPAIGN_UPDATED

group

Get records for a specified group. Available groups are all, reservations and users. Group all is default.

/v1/event-tracking?group=reservations

website

Get records for a specified website name.

/v1/event-tracking?website=xx Website

Response

{
  "result": {
    "events": [
      {
        "eventId": 1,
        "event": {
          "entity": "CAMPAIGN",
          "operation": "CAMPAIGN_CREATED",
          "eventTime": "2020-01-01T10:00:00+00:00",
          "eventUser": {
            "id": 1,
            "userName": "user"
          },
          "id": 1,
          "data": [],
          "notificationId": 1
        }
      },
      {
        "eventId": 2,
        "event": {
          "entity": "CAMPAIGN",
          "operation": "RESERVATION_ITEM_CREATED",
          "eventTime": "2020-01-01T10:00:00+00:00",
          "eventUser": {
            "id": 1,
            "userName": "user"
          },
          "id": 2,
          "data": {
            "name": "Placement (Data) - 2020-01-01",
            "bookingIds": "1",
            "reservationItem": {
              "id": 1,
              "expirationDate": "2020-01-01"
            },
            "campaign": {
              "id": 1,
              "name": "Campaign name"
            },
            "placement": {
              "id": 1,
              "name": "Placement (Data)"
            }
          },
          "notificationId": 2
        }
      }
    ],
    "hasMore": false
  }
}