Games

Games:

Callbacks:

Media:

Ticker

Due to the history of tickaroo coming from sports events, the term “Game” is used in type names for ticker or live blog.

Create Ticker

Request: POST /api/v5/write/ticker/create.json

Query Parameters: (none)

Post Document:

{
  // (string) Owner Organization ID
  "organization_id": "",

  // (string) (Sportstype or Custom Template ID)
  "template_id": "",

  // Tik::Model::BasicGameMetaInfo
  "meta_info": "",

  // Tik::Model::BasicGameOptions
  "options": "",

  // (array[String])
  "tags": "",
  
  // (string) will be used to build local_id (<org_id>_<external_id>)
  "external_id": ""
}

Examples

Post Document (news):

{  
   "template_id": "news",
   "_type": "Tik::Model::Game",
   "organization_id": "YOURID",
   "meta_info": {  
      "_type": "Tik::Model::GameMetaInfo::TitleGameMetaInfo",
      "editorial_publishing": false,
      "allow_comments": false,
      "starts_at": 1531985104,
      "title": "news title"
   }
}

Post Document (soccer):

{  
  "template_id": "soccer",
  "_type": "Tik::Model::Game",
  "organization_id": "YOURID",
  "options": {  
    "_type": "Tik::Model::Options::TimedGameOptions",
    "timing_type": "aui",
    "overtime_phase_length": 15,
    "regular_phase_length": 45,
    "num_regular_phases": 2
  },
  "meta_info": {  
    "_type": "Tik::Model::GameMetaInfo::TeamGameMetaInfo",
    "away_team": {  
       "_type": "Tik::Model::Team",
       "name": "Team Name"
    },
    "home_team": {  
       "_type": "Tik::Model::Team",
       "_id": "4fbf4f063ab9c8664f0000be"
    },
    "tournament": {  
       "_type": "Tik::Model::Tournament",
       "_id": "50b8ff66f92ea1541e00028f"
    },
    "editorial_publishing": false,
    "allow_comments": true,
    "starts_at": 1531985104
  }
}

Success Response: Tik::Model::Game Object

Modify Ticker

Send one or more modifications to update a ticker.

Return value: Tik::Model::Game (decorated)

Request: POST /api/v5/write/ticker/post_modifications.json

Query Parameters: (none)

Post Document:

{ 
  // local_id of the ticker
  "local_id": "",

  // ticker_id of the ticker (alternative to local_id)
  "ticker_id": "",

  // (array[Tik::Model::Modification::UserModification])
  "modifications": [],    
}

Success Response: Tik::Model::Game (decorated) Object

Allowed Modifications:

  • UpdateGameMetaInfoModification
  • UpdateGameMarketplaceInfoModification
  • DeleteGameModification

Examples

Post Document (UpdateGameMetaInfoModification with TitleGameMetaInfo):

{  
  "local_id": "5b34adaf40504547f6c2f8eb",
  "modifications": [  
      {  
          "_type": "Tik::Model::Modification::UpdateGameMetaInfoModification",
          "sportstype": "news",
          "meta_info": {  
              "_type": "Tik::Model::GameMetaInfo::TitleGameMetaInfo",
              "title": "Some new title",
              "editorial_publishing": false,
              "allow_comments": true,
              "starts_at": 1531985104
          }
      }
  ]
}

Post Document (UpdateGameMetaInfoModification with TeamGameMetaInfo):

{  
  "local_id": "5b34adaf40504547f6c2f8eb",
  "modifications": [  
      {  
          "_type": "Tik::Model::Modification::UpdateGameMetaInfoModification",
          "sportstype": "soccer",
          "meta_info": {  
              "_type": "Tik::Model::GameMetaInfo::TeamGameMetaInfo",
              "away_team": {  
                  "_type": "Tik::Model::Team",
                  "name": "Team Name"
              },
              "home_team": {  
                  "_type": "Tik::Model::Team",
                  "_id": "4fbf4f063ab9c8664f0000be"
              },
              "tournament": {  
                  "_type": "Tik::Model::Tournament",
                  "_id": "50b8ff66f92ea1541e00028f"
              },
              "editorial_publishing": false,
              "allow_comments": true,
              "starts_at": 1531985104,
              "location": {  
                  "_type": "Tik::Model::Location",
                  "_id": "4f9044903ab9c80f72000018"
              }
          }
      }
  ]
}

Post Document (DeleteGameModification):

{  
  "local_id": "5b34adaf40504547f6c2f8eb",
  "modifications": [  
      {  
          "_type": "Tik::Model::Modification::DeleteGameModification",
          "local_status": "100"
      }
  ]
}

Post Document (UpdateGameMarketplaceInfoModification):

{  
  "local_id": "5b34adaf40504547f6c2f8eb",
  "modifications": [  
      {  
          "_type": "Tik::Model::Modification::UpdateGameMarketplaceInfoModification",
          "marketplace_info": {
            "_type": "Tik::Model::MarketplaceInfo::BasicMarketplaceInfo",
            "pricing": {
              "_type": "Tik::Model::Pricing",
              "_id": "5922a99ce4b00d3c231c8573"
            },
            "detail": "Ticker Marketplace description"
          }
      }
  ]
}

Show Ticker

Request: GET /api/v5/write/ticker/show.json

Query Parameters:

  • local_id: The local_id of the ticker

or

  • ticker_id: The ticker_id of the ticker

  • compact: Returns a compact version of the ticker (default: false)

Success Response: Tik::Model::Game (decorated) Object

List/Filter Ticker

Request: GET /api/v5/write/ticker/search.json

Query Parameters:

  • owner_id: The ID of the owning user/organization
  • q: Query
  • template_id: Custom template or Sportstype
  • team_id: Team to filter by
  • tag: Tag to filter by
  • timeframe: Time period to filter by. Allowed values [‘today’, ‘tomorrow’, ‘thisweek’, ‘nextweek’, ‘thismonth’, ‘nextmonth’, ‘upcoming’, ‘current’, ‘future’, ‘monday’, ‘tuesday’, ‘wednesday’, ‘ thursday’, ‘friday’, ‘saturday’, ‘sunday’, ‘all’, ‘past’]
  • limit: Limit results per page
  • more: Page number

Success Response: Tik::Model::Collection[Tik::Model::Game] (decorated) Object

Callbacks

Pushservice is used for callbacks. On each ticker modification insert, Tickaroo will trigger a push notification.

Subscribe

Request: Post /api/v5/write/callbacks/subscribe.json

Query Parameters:

  • organization_id: The organization to subscribe to
  • url: The URL to subscribe

Success Response: Tik::Model::ApiSuccess

Unsubscribe

Request: Post /api/v5/write/callbacks/unsubscribe.json

Query Parameters:

  • organization_id: The organization to unsubscribe to
  • url: The URL to unsubscribe

Success Response: Tik::Model::ApiSuccess

Subscriptions

Request: Post /api/v5/write/callbacks/subscriptions.json

Query Parameters:

  • organization_id: The organization with subscriptions

Success Response:

{
  "urls": ["url1", "url2"]
}

Media

Download

Request: Get /api/mediaproxy/v1/download

Query Parameters:

  • url: Tickaroo Media URL

Directly downloads the original video

Metainfo

Request: Get /api/mediaproxy/v1/video_metadata.json

Query Parameters:

  • url: Tickaroo Media URL

Get video meta info of the original video (Bitrate etc.)