Example of creating and sending Caliper Analytics data

caliper_test.py

import pprint

from datetime import datetime

import caliper

from caliper import events, entities
from caliper.constants import CALIPER_ACTIONS

sensor_config = caliper.HttpOptions(
    host='(host)',
    auth_scheme='Bearer',
    api_key='(api_key provided)'
)

sensor = caliper.build_sensor_from_config(
    sensor_id='https://caliper.imsglobal.org/testserver',
    config_options=sensor_config
)

event = events.SessionEvent(
    actor=entities.Person(id='https://example.com/user/123'),
    action=CALIPER_ACTIONS['LOGGED_IN'],
    object=entities.SoftwareApplication(id='https://example.com/application/1'),
    eventTime=datetime.utcnow().isoformat(timespec='milliseconds') + 'Z'
)

actor = entities.Person(
    # Required Property
    id='https://example.com/user/123',

    # Optional Property
    name='Yungon Park'
)

video_object = entities.VideoObject(
    # Required Property
    id='https://example.com/video/1234',

    # Optional Property
    name='Introduction of Caliper Analytics',
    duration='PT10M15S'     # ISO 8601 duration format
)

media_event = events.MediaEvent(
    actor=actor,
    action=CALIPER_ACTIONS['STARTED'],
    object=video_object,
    eventTime=datetime.utcnow().isoformat(timespec='milliseconds') + 'Z'
)

pprint.pprint(media_event.as_dict(thin_context=True, thin_props=True))

sensor.send(event)
sensor.send(media_event)