Create a fact

POST

/v2/matches/{matchId}/facts

curl --request POST \
  --url https://api.ligr.live/rest/v2/matches/1/facts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "periodNumber": 1, "teamId": 1, "playerId": 1, "playerTwoId": 1, "date": "example", "data": "example", "meta": "example" }'

• LIGR REST API

Create a new fact for a match. Facts record discrete match events, such as goals or cards.

Authorizations

• bearer
  matches:write
• api_key
  matches:write

Parameters

Path Parameters

matchId

required

Entity identifier

integer format: int32

>= 1

The match identifier

Request Body^required

Media typeapplication/json

object

name

required

string

periodNumber

required

integer format: int32

teamId

integer format: int32

nullable

playerId

integer format: int32

nullable

playerTwoId

integer format: int32

nullable

date

string

data

Sport-specific detail of the event, for example the goal type or the card colour. The shape depends on the sport and the fact name.

meta

Free-form metadata that travels with the fact. LIGR stores it as sent.

Example^generated

{
  "name": "example",
  "periodNumber": 1,
  "teamId": 1,
  "playerId": 1,
  "playerTwoId": 1,
  "date": "example",
  "data": "example",
  "meta": "example"
}

Responses

201

Media typeapplication/json

object

id

required

Entity identifier

integer format: int32

>= 1

matchId

required

Entity identifier

integer format: int32

>= 1

name

required

string

periodNumber

required

number format: double

createdAt

required

string

Example^generated

{
  "id": 1,
  "matchId": 1,
  "name": "example",
  "periodNumber": 1,
  "createdAt": "example"
}

400

Request is invalid

Media typeapplication/json

object

message

required

string

details

required

object

key

additional properties

Example^generated

{
  "message": "example",
  "details": {
    "additionalProperty": "example"
  }
}

401

Missing or invalid api key

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

403

Api key provides insufficient access for the request

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

404

Match or fact not found

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

429

Api key has made too many requests

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}

500

An unexpected error has occured. If problems persist please contact support

Media typeapplication/json

object

message

required

string

Example^generated

{
  "message": "example"
}