Amazon Personalize Events

{'eventList': {'metricAttribution': {'eventAttributionSource': 'string'}}}

Records user interaction event data. For more information see Recording Events.

See also: AWS API Documentation

Request Syntax

client.put_events(
    trackingId='string',
    userId='string',
    sessionId='string',
    eventList=[
        {
            'eventId': 'string',
            'eventType': 'string',
            'eventValue': ...,
            'itemId': 'string',
            'properties': 'string',
            'sentAt': datetime(2015, 1, 1),
            'recommendationId': 'string',
            'impression': [
                'string',
            ],
            'metricAttribution': {
                'eventAttributionSource': 'string'
            }
        },
    ]
)

type trackingId:

string

param trackingId:

[REQUIRED]

The tracking ID for the event. The ID is generated by a call to the CreateEventTracker API.

type userId:

string

param userId:

The user associated with the event.

type sessionId:

string

param sessionId:

[REQUIRED]

The session ID associated with the user's visit. Your application generates the sessionId when a user first visits your website or uses your application. Amazon Personalize uses the sessionId to associate events with the user before they log in. For more information, see Recording Events.

type eventList:

list

param eventList:

[REQUIRED]

A list of event data from the session.

• (dict) --

  Represents user interaction event information sent using the PutEvents API.

  • eventId (string) --

    An ID associated with the event. If an event ID is not provided, Amazon Personalize generates a unique ID for the event. An event ID is not used as an input to the model. Amazon Personalize uses the event ID to distinquish unique events. Any subsequent events after the first with the same event ID are not used in model training.

  • eventType (string) -- [REQUIRED]

    The type of event, such as click or download. This property corresponds to the EVENT_TYPE field of your Interactions schema and depends on the types of events you are tracking.

  • eventValue (float) --

    The event value that corresponds to the EVENT_VALUE field of the Interactions schema.

  • itemId (string) --

    The item ID key that corresponds to the ITEM_ID field of the Interactions schema.

  • properties (string) --

    A string map of event-specific data that you might choose to record. For example, if a user rates a movie on your site, other than movie ID ( itemId) and rating ( eventValue) , you might also send the number of movie ratings made by the user.

    Each item in the map consists of a key-value pair. For example,

    {"numberOfRatings": "12"}

    The keys use camel case names that match the fields in the Interactions schema. In the above example, the numberOfRatings would match the 'NUMBER_OF_RATINGS' field defined in the Interactions schema.

  • sentAt (datetime) -- [REQUIRED]

    The timestamp (in Unix time) on the client side when the event occurred.

  • recommendationId (string) --

    The ID of the list of recommendations that contains the item the user interacted with. Provide a recommendationId to have Amazon Personalize implicitly record the recommendations you show your user as impressions data. Or provide a recommendationId if you use a metric attribution to measure the impact of recommendations.

    For more information on recording impressions data, see Recording impressions data. For more information on creating a metric attribution see Measuring impact of recommendations.

  • impression (list) --

    A list of item IDs that represents the sequence of items you have shown the user. For example, ["itemId1", "itemId2", "itemId3"]. Provide a list of items to manually record impressions data for an event. For more information on recording impressions data, see Recording impressions data.

    • (string) --

  • metricAttribution (dict) --

    Contains information about the metric attribution associated with an event. For more information about metric attributions, see Measuring impact of recommendations.

    • eventAttributionSource (string) -- [REQUIRED]

      The source of the event, such as a third party.

returns:

None