Sitecore Experience Platform

Collection service public endpoints

The collection service has two controllers that can receive data submitted by public clients:

  • EventController - the web endpoint for working with tracking event data. Intended for use by non-C# clients such as JS.

    Method name

    Param Name

    Param type

    Purpose

    Returns

    PutAsync

    events

    IEnumerable<JObject>

    The events to store

    Task<IActionResult>

  • InteractionController - the web endpoint for working with interactions. Intended to be called from non-C# clients such as JS.

    Method name

    Param Name

    Param type

    Purpose

    Returns

    PutAsync

    interaction

    JObject

    The interaction to store

    Task<IActionResult>

    CompleteAsync

    id

    Guid

    The ID of the interaction to complete

    Task<IActionResult>

You can get the following response codes from the API:

Status code

Note

201 Created

The events were successfully stored in the database.

202 Accepted

The interaction was successfully marked as ready for processing.

400 BadRequest

The client provided invalid data. The response contains a list of validation errors.

500 InternalServerError

An error occurred on the server side. For example, data is valid, but was not saved to the database due to a failed SQL connection.