Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
{
    "PublisherProgramId": "ProgramId",
    "PublisherEventId": "some_key_id",
    "EventType": "Event Type indicator",
    "PublisherParticipantId": "joebob@example.com",
    "PublisherEventData": { JSON },
    "EventStartUTCEventStartUtc": "UTC date/time",
    "EventEndUTCEventEndUtc": "UTC date/time"
}

Parameter

Description

PublisherProgramId

The Program that owns the Event.

The API Key must have access to this Program.

PublisherEventId

A value that uniquely identifies this event in the publisher’s system.

For LearningBuilder publishers, this will be an “entity-scoped identifier” such as AI:1234, representing Activity Instance 1234.

EventType

The type of Event this record represents.

See the “Event Types” section, above.

PublisherParticipantId

Email address or some other piece of information that uniquely identifiers the primary participant within the Program’s system.

PublisherEventData

JSON object representing the Event in the source Program’s system.

EventStartUTCEventStartUtc

The UTC date/time when this Event occurred, or the time that the Event started.

EventEndUTCEventEndUtc

The UTC date/time when this Event ended. For Events with only a single timestamp, rather than a range, set this equal to EventStartUTC.

...

Response Code

Headers and Body

200 (Ok)

Code Block
languagejson
[
  {
      "PublisherProgramId": "ProgramId",
      "PublisherEventId": "some_key_id",
      "EventType": "Event Type indicator",
      "PublisherParticipantId": "joebob@example.com",
      "PublisherEventData": { JSON },
      "EventStartUTCEventStartUtc": "UTC date/time",
      "EventEndUTCEventEndUtc": "UTC date/time"
  },
  ...
]

...