---
title: "Returns personalization events"
method: GET
path: "/analytics/{eventType}"
tags: ["Analytics"]
---

# Returns personalization events

`GET /analytics/{eventType}`

## Request

- The document declares no server URL.
- Auth: API key in header `TWN-InstanceKey` and API key in header `TWN-Authentication`

## Path parameters

- `eventType` 'ItemClick' | 'PageView' | 'Purchase' | 'Search' | 'SessionStart' | 'AddToWishlist' | 'AddToCart' | 'PageImpression', required

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `limit` integer
- `offset` integer

## Response `200`

OK

- ApiPersonalizationEventSummaries
  - `Total` integer, nullable, required: The total number of records which can be retrieved. Note that this field is not available for all paginated endpoints.
  - `Records` ApiPersonalizationEventSummary[], required: The retrieved records.
    - `Event` 'ItemClick' | 'PageView' | 'Purchase' | 'Search' | 'SessionStart' | 'AddToWishlist' | 'AddToCart' | 'PageImpression'
    - `Payload` union
      - object
        - `discriminator` 'ApiPersonalizationItemClicksEvent', required
        - `ItemId` string: The identifier of the item that was clicked.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationPageViewsEvent', required
        - `ProductKey` string: The product key of the viewed product.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationPurchasesEvent', required
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationSearchesEvent', required
        - `SearchTerm` string: The search term used in the search event.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationSessionStartsEvent', required
        - `Source` string, nullable: The source from which the session was started.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationAddToWishlistsEvent', required
        - `ProductKey` string: The product key of the added product.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationAddToCartsEvent', required
        - `ProductKey` string: The product key of the added product.
        - `Quantity` integer: The quantity that was added.
        - `TotalAmount` number, double: The total amount of the added product.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.
      - object
        - `discriminator` 'ApiPersonalizationPageImpressionsEvent', required
        - `RequestId` string: The requestid for the page impression.
        - `EventEnqueuedUtcTime` string, date-time: The UTC timestamp indicating when the event was enqueued.

---

[API](https://skmtc.dev/tweakwise/apis/app-api.md) - [All operations](https://skmtc.dev/tweakwise/apis/app-api/llms.txt) - [OpenAPI document](https://skmtc.dev/tweakwise/apis/app-api/revisions/dc936bf76941?raw)