Amazon Mobile Analytics

2015/03/19 - Amazon Mobile Analytics - 1 new api methods

PutEvents (new) Link ΒΆ

The PutEvents operation records one or more events. You can have up to 1,500 unique custom events per app, any combination of up to 40 attributes and metrics per custom event, and any number of attribute or metric values.

Request Syntax

client.put_events(
    events=[
        {
            'eventType': 'string',
            'timestamp': 'string',
            'session': {
                'id': 'string',
                'duration': 123,
                'startTimestamp': 'string',
                'stopTimestamp': 'string'
            },
            'version': 'string',
            'attributes': {
                'string': 'string'
            },
            'metrics': {
                'string': 123.0
            }
        },
    ],
    clientContext='string',
    clientContextEncoding='string'
)
type events

list

param events

[REQUIRED]

An array of Event JSON objects

  • (dict) --

    A JSON object representing a batch of unique event occurrences in your app.

    • eventType (string) -- [REQUIRED]

      A name signifying an event that occurred in your app. This is used for grouping and aggregating like events together for reporting purposes.

    • timestamp (string) -- [REQUIRED]

      The time the event occurred in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z

    • session (dict) --

      The session the event occured within.

      • id (string) --

        A unique identifier for the session

      • duration (integer) --

        The duration of the session.

      • startTimestamp (string) --

        The time the event started in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z

      • stopTimestamp (string) --

        The time the event terminated in ISO 8601 standard date time format. For example, 2014-06-30T19:07:47.885Z

    • version (string) --

      The version of the event.

    • attributes (dict) --

      A collection of key-value pairs that give additional context to the event. The key-value pairs are specified by the developer.

      This collection can be empty or the attribute object can be omitted.

      • (string) --

        • (string) --

    • metrics (dict) --

      A collection of key-value pairs that gives additional, measurable context to the event. The key-value pairs are specified by the developer.

      This collection can be empty or the attribute object can be omitted.

      • (string) --

        • (float) --

type clientContext

string

param clientContext

[REQUIRED]

The client context including the client ID, app title, app version and package name.

type clientContextEncoding

string

param clientContextEncoding

The encoding used for the client context.

returns

None