Skip to content

Analytics API

If you are using your own or a third party Media Player, Broox Studio will not be aware of the content being reproduced.

To associate reproduction information to any event, you have to inform Broox Controller of the current media playing status.

For that we can use the Broox Controller API Endpoint.

The endpoint is listening for HTTP requests on port 9912 of the Broox Controller hosting machine.

  • Method: POST
  • URL: http://broox-controller-ip:9912/media
  • Expects: application/json

  • A dictionary containing ALL OF:

    • installation_id: string internal ID of the installation. You can get it on the Installation Screen on Broox Studio.

    • campaign_name: string user facing campaign name. e.g. Summer Campaign
    • playlist_name: string user facing playlist name. e.g. Summer Man Trousers Playlist
    • media_name: string user facing media name. e.g. Trousers_Blue.mp4
    • Optionally, internal identifiers (machine facing) of campaign, playlist and media. If you are using integer database keys, convert them to strings.
    • campaign_id: string
    • playlist_id: string
    • media_id: string
    • Returns: text/plain
    • HTTP status 200 and the text "Ok" if correctly updated.
    • A HTTP error code on failure, and a textual description on the body.

Example

POST http://127.0.0.1:9912/media HTTP/1.0
Content-type: application/json

{"installation_id": "-X43aF3le3afg","campaign_name":"Summer 2022","playlist_name":"Men Trousers","media_name":"BlueTrousers.mp4"}

CURL Example

curl --request POST \
  --url http://127.0.0.1:9912/media \
  --header 'content-type: application/json' \
  --data '{"installation_id": "-X43aF3le3afg","campaign_name":"Summer 2022",
            "playlist_name":"Men Trousers","media_name":"BlueTrousers.mp4"}'