Match PLAY BY PLAY
A match involves a number of events. These events aggregate to form a play-by-play. The play-by-play assigned to a match are controlled by these calls.
Get a list play-by-play records for a match
Return a list of play-by-play records for a match
- : Read any data from the organization down
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Where the date/time (UTC) this play-by-play event was sent >= this value
2018-08-16T18:00:00Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
1000Example: 10The offset of the records. See Pagination for more information.
10The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
Where the date/time (UTC) this play-by-play event was sent <= this value
2018-08-16T18:00:00Successful operation
Error
Delete all play-by-play records for a match
Delete all play-by-play records for a match
- : Write/Update any data from below the organization
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Force a delete command to run and delete child records as well if there are existing records depending on the record.
trueDon't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesSuccessful operation
Error
Get a list of live play-by-play records for a match
Return a list of live play-by-play records for a match. This call will return records of matches still in-progress if available. If the match is complete this call operates the same as the non 'live' route.
Rate limited to 2 requests every minute - returns HTTP 429 Too Many Requests if called more often.You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
- : Authenticate based on a specific OrganizationId
- : Read data over multiple organizations using and *orggroup* code
- : Write/Update any data from below the organization
- : Read any data from the organization down
- : Perform administration API calls
- : Ability to manage organizations
- : Perform system configuration API calls
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Where the date/time (UTC) this play-by-play event was sent >= this value
2018-08-16T18:00:00Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
1000Example: 10The offset of the records. See Pagination for more information.
10The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
Where the date/time (UTC) this play-by-play event was sent <= this value
2018-08-16T18:00:00Successful operation
Error
Get a full list of match events, suitable for subsequent import.
Includes play-by-play and setup events for a match
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
- : Authenticate based on a specific OrganizationId
- : Read data over multiple organizations using and *orggroup* code
- : Write/Update any data from below the organization
- : Read any data from the organization down
- : Perform administration API calls
- : Ability to manage organizations
- : Perform system configuration API calls
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe maximum number of records to return. See Pagination for more information.
10Example: 10The offset of the records. See Pagination for more information.
10Include only setup events when exporting?
The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
Include scores in exported events?
Successful operation
Error
Add or Update historical play-by-play records for a match
Depending on primary keys, Add a match play-by-play or update an existing record. This call operates in bulk for all events in a specific period. Note:This call should only be used to import historical data. Changes to current/live data show be peformed only via your live capture software. If this call is used data may become invalid as statistics/actions may not be recalculated.
- : Perform administration API calls
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesSuccessful operation
Error
Add an individual a match play-by-play event
Add a specific period play-by-play from a match event
- : Perform administration API calls
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdThe section of the period (sub-period)
The unique identifier of the match
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
The section of the period (sub-period)
The class of the event
clockInformation about the current status of the clock matchsportA sporting action that relates to the running of the match
sportExample: sportPossible values: Unique identifier of this event
009e9276-5c80-11e8-9c2d-fa7ae01bbebcUnique identifier of this play (group of events)
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the team
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the person
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe Sub Type of event. See Streaming API documenation for more information.
outThe UNIX timestamp when the event was received.
The status of this message. Options are added (Default); updated - meaning the content of this event has been edited; deleted - meaning this event has been deleted; enriched - meaning further information has been added to the event (not changed).
Whether the action was successful
The x co-ordinate of the event. Represented as percentage from left (0) to right (100).
56The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).
23The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).
10The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS
PT12M34.5SThe time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS
PT34.2SThe date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.
2016-09-08T02:02:00ZThe unique ID of the official making this decision
009e9276-5c80-11e8-9c2d-fa7ae01bbebcSee Event Types for more information
The date/time (UTC) this event was sent.
2016-09-08T02:02:00ZType of the client that sent the event
InGameID of the client that sent the event
InGame:0.9Sport one letter code
hMQTT topic where the event was sent
s/h/h1s44/3c467c99-9e5d-11ee-91d0-2b012330fcf5/w/eType of the event message
eventClient event sequence number
10Successful operation
Error
Delete a match play-by-play
Delete a specific period play-by-play from a match
- : Write/Update any data from below the organization
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Force a delete command to run and delete child records as well if there are existing records depending on the record.
trueDon't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe section of the period (sub-period)
Successful operation
Error
Update an individual a match play-by-play event
Update a specific period play-by-play from a match event
- : Perform administration API calls
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of an event in a match
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdThe section of the period (sub-period)
The class of the event
clockInformation about the current status of the clock matchsportA sporting action that relates to the running of the match
sportExample: sportPossible values: Unique identifier of this event
009e9276-5c80-11e8-9c2d-fa7ae01bbebcUnique identifier of this play (group of events)
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the team
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the person
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe Sub Type of event. See Streaming API documenation for more information.
outThe UNIX timestamp when the event was received.
The status of this message. Options are added (Default); updated - meaning the content of this event has been edited; deleted - meaning this event has been deleted; enriched - meaning further information has been added to the event (not changed).
Whether the action was successful
The x co-ordinate of the event. Represented as percentage from left (0) to right (100).
56The y co-ordinate of the event. Represented as precentage from top (0) to bottom (100).
23The z co-ordinate of the event. Represented as precentage from ground (0) to ceiling (100).
10The time on the clock when the event occurred. ISO 8601 format. PTmmMss.ccS
PT12M34.5SThe time on the shot clock when the event occurred. ISO 8601 format. PTss.ccS
PT34.2SThe date/time (UTC) this event occurred. For inserted actions, this should be the time the action would have occurred, not the time of insertion.
2016-09-08T02:02:00ZThe unique ID of the official making this decision
009e9276-5c80-11e8-9c2d-fa7ae01bbebcSee Event Types for more information
The date/time (UTC) this event was sent.
2016-09-08T02:02:00ZType of the client that sent the event
InGameID of the client that sent the event
InGame:0.9Sport one letter code
hMQTT topic where the event was sent
s/h/h1s44/3c467c99-9e5d-11ee-91d0-2b012330fcf5/w/eType of the event message
eventClient event sequence number
10Successful operation
Error
Delete a match play-by-play event
Delete a specific period play-by-play from a match event
- : Perform administration API calls
You can create a JSON Web Token (JWT) using the token API call. Each token is given a set of scopes/permissions. Each endpoint has a scope/permission that it requires to run. If your token does not possess the correct scope then you will be unable to make the API call.
The unique identifier of an event in a match
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the fixture
009e9276-5c80-11e8-9c2d-fa7ae01bbebcThe unique identifier of the organization
b1a23The identifier for the period
- None Total match
1Period 12Period 23Period 311Overtime 112Overtime 213Overtime 314Overtime 415Overtime 516Overtime 617Overtime 718Overtime 819Overtime 920Overtime 1021Overtime 1122Overtime 1223Overtime 1324Overtime 1425Overtime 1526Overtime 1627Overtime 1728Overtime 1829Overtime 1930Overtime 20
A comma separated list of fields that will instead be interpreted as an externalId. See External Ids for more information.
entityId,personIdA comma separated list of fields to display. The response will only display these fields. See Partial Response section for more information.
dob,firstName,organization(id),organizations[name], teams[name,details/metrics/*,tags(id)]Don't display data fields with null values or empty structures
trueA comma separated list of resource types to include. See Resource Inclusion for more information.
organizations,fixtures,entitiesThe section of the period (sub-period)
Successful operation
Error
Last updated
Was this helpful?