Skip to main content

Publisher API

Swagger JSON | API Console​

The Publisher API is the API that most applications will embed into a production system. This API contains the methods necessary to send new events into Retraced, create viewer tokens and to programmatically search events when the embedded viewer is not being used.

When possible, it's recommended to use one of the supported SDKs as these provide an easier way to get started.

To consume the Publisher API directly, we publish a Swagger spec that is both documented and available in a raw json object. The endpoints for reporting events are /project/{project_id}/event and /project/{project_id}/event/bulk. The bulk endpoint is for reporting multiple events in a single call. Clients using the bulk endpoint should expect longer response times when submitting large numbers of events.

Body​

We send an event json to /project/{project_id}/event API.

Following are the mandatory fields.

{
    "action": "action-name",
    "crud": "c" | "r" | "u" | "d",
    "actor": {
        "id": "actor-id",
        "name": "actor-name"
}

In case of /project/{project_id}/event/bulk API we will send an array of events like below,

{
    "events": [
        {
            "action": "action-name",
            "crud": "c" | "r" | "u" | "d",
            "actor": {
                "id": "actor-id",
                "name": "actor-name"
            },
        },
        {
            "action": "action-name",
            "crud": "c" | "r" | "u" | "d",
            "actor": {
                "id": "actor-id",
                "name": "actor-name"
            }
        }
    ]
}

Publisher API Tokens​

You can find the Publisher API token in the Admin Portal. These tokens are used to authenticate the Publisher API requests. You can open the projects section and under project information, you can find the Production token this token is used to authenticate the Publisher API requests.

Authentication​

The Publisher API endpoints expect the token to be provided in a header of the form

Authorization: token=YOUR_PUBLISHER_TOKEN