Match Reports (TWW)

GET /tournaments/{tournament_id}/matches/{match_id}/reports

Authorized Access

Returns the matches report of the given match using various filters.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/reports

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

  • Range
    string

    A range of requested items using the reports unit. The size of the range cannot exceed 50. (see Pagination)

    Example: reports=0-49

Path parameters

  • tournament_id
    string

    The id of the desired tournament.

    Example: 378426939508809728

  • match_id
    string

    The id of the match.

    Example: 212738912376478976

Query Parameters

  • participant_ids
    array

    One or several participant ids involved in the matches to filter

    Example: 618965416546776434,618975467354349191

  • types
    array

    One or several match statuses to filter

    Example: report,dispute

  • is_closed
    boolean

    Whether to include or exclude scheduled matches

    Possible values: 0, 1

Request Body

This endpoint doesn't require a request body.

Response

[206] Report retrieved

Example
[
    {
        "id": "168954615761461654",
        "type": "dispute",
        "closed": false,
        "closed_at": "2015-12-31T00:00:00+00:00",
        "closed_author_id": "513743143408302391",
        "note": "A note on\ntwo lines\n",
        "participant_id": "375143143408309123",
        "user_id": "513743143408302391",
        "custom_user_identifier": "acme:account:1234",
        "report": {
            "opponents": [
                {
                    "score": 15,
                    "number": 1,
                    "result": "win",
                    "forfeit": false
                }
            ]
        }
    }
]
Structure (collection)
  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    datetime|null

    The timestamp on which the match was played (a result was provided)

    Format: RFC 3339 (combined date, time and utc offset)

    Example: "2015-12-31T00:00:00+00:00"

  • closed_author_id
    integer|null

    The id of user who closed the report

    Example: 513743143408302391

  • note
    string|null

    Private note of a report, only visible by organizer.

    Example: "A note on\ntwo lines\n"

  • participant_id
    integer

    The id of participant

    Example: 375143143408309123

  • user_id
    integer

    The id of user

    Example: 513743143408302391

  • custom_user_identifier
    string

    The custom user identifier

    Example: "acme:account:1234"

  • report
    object

POST /tournaments/{tournament_id}/matches/{match_id}/reports

Authorized Access

Create a match report in a match, there can only be one report per participant.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/reports

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the match's tournament.

    Example: 378426939508809728

  • match_id
    string

    The id of the match.

    Example: 212738912376478976

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Create a match_report

Example
{
    "note": "A note on\ntwo lines\n",
    "participant_id": "375143143408309123",
    "type": "dispute",
    "user_id": "513743143408302391",
    "custom_user_identifier": "acme:account:1234",
    "report": {
        "opponents": [
            {
                "score": 15,
                "number": 1,
                "result": "win",
                "forfeit": false
            }
        ]
    }
}
Structure (object)
  • note
    string|null

    Optional

    Private note of a report, only visible by organizer.

    Example: "A note on\ntwo lines\n"

  • participant_id
    integer

    The id of participant

    Example: 375143143408309123

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • user_id
    integer

    Optional

    The id of user

    Example: 513743143408302391

  • custom_user_identifier
    string

    Optional

    The custom user identifier

    Example: "acme:account:1234"

  • report
    object

Response

[201] Success

Example
{
    "id": "168954615761461654",
    "type": "dispute",
    "closed": false,
    "closed_at": "2015-12-31T00:00:00+00:00",
    "closed_author_id": "513743143408302391",
    "note": "A note on\ntwo lines\n",
    "participant_id": "375143143408309123",
    "user_id": "513743143408302391",
    "custom_user_identifier": "acme:account:1234",
    "report": {
        "opponents": [
            {
                "score": 15,
                "number": 1,
                "result": "win",
                "forfeit": false
            }
        ]
    }
}
Structure (object)
  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    datetime|null

    The timestamp on which the match was played (a result was provided)

    Format: RFC 3339 (combined date, time and utc offset)

    Example: "2015-12-31T00:00:00+00:00"

  • closed_author_id
    integer|null

    The id of user who closed the report

    Example: 513743143408302391

  • note
    string|null

    Private note of a report, only visible by organizer.

    Example: "A note on\ntwo lines\n"

  • participant_id
    integer

    The id of participant

    Example: 375143143408309123

  • user_id
    integer

    The id of user

    Example: 513743143408302391

  • custom_user_identifier
    string

    The custom user identifier

    Example: "acme:account:1234"

  • report
    object

GET /tournaments/{tournament_id}/matches/{match_id}/report/{id}

Authorized Access

Returns a match report by the given id.

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/report/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:result scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the match's tournament.

    Example: 378426939508809728

  • match_id
    string

    The id of the match.

    Example: 212738912376478976

  • id
    string

    The id of the match report to retrieve.

    Example: 1212738912376478976

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

This endpoint doesn't require a request body.

Response

[200] Match retrieved

Example
{
    "id": "168954615761461654",
    "type": "dispute",
    "closed": false,
    "closed_at": "2015-12-31T00:00:00+00:00",
    "closed_author_id": "513743143408302391",
    "note": "A note on\ntwo lines\n",
    "participant_id": "375143143408309123",
    "user_id": "513743143408302391",
    "custom_user_identifier": "acme:account:1234",
    "report": {
        "opponents": [
            {
                "score": 15,
                "number": 1,
                "result": "win",
                "forfeit": false
            }
        ]
    }
}
Structure (object)
  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    datetime|null

    The timestamp on which the match was played (a result was provided)

    Format: RFC 3339 (combined date, time and utc offset)

    Example: "2015-12-31T00:00:00+00:00"

  • closed_author_id
    integer|null

    The id of user who closed the report

    Example: 513743143408302391

  • note
    string|null

    Private note of a report, only visible by organizer.

    Example: "A note on\ntwo lines\n"

  • participant_id
    integer

    The id of participant

    Example: 375143143408309123

  • user_id
    integer

    The id of user

    Example: 513743143408302391

  • custom_user_identifier
    string

    The custom user identifier

    Example: "acme:account:1234"

  • report
    object

PATCH /tournaments/{tournament_id}/matches/{match_id}/report/{id}

Authorized Access

Updates one match report

Resource URL

https://api.toornament.com/organizer/v2/tournaments/{tournament_id}/matches/{match_id}/report/{id}

HTTP headers

  • X-Api-Key
    string

    API key of your application (see Authentication)

  • Authorization
    string

    Access token with organizer:participant scope (see Authorization)

Path parameters

  • tournament_id
    string

    The id of the match's tournament.

    Example: 378426939508809728

  • match_id
    string

    The id of the match.

    Example: 212738912376478976

  • id
    string

    The id of the match report to retrieve.

    Example: 1212738912376478976

Query Parameters

This endpoint doesn't have any query parameters.

Request Body

Participant data

Example
{
    "note": "A note on\ntwo lines\n",
    "closed": false,
    "user_id": "513743143408302391",
    "custom_user_identifier": "acme:account:1234",
    "report": {
        "opponents": [
            {
                "score": 15,
                "number": 1,
                "result": "win",
                "forfeit": false
            }
        ]
    }
}
Structure (object)
  • note
    string|null

    Optional

    Private note of a report, only visible by organizer.

    Example: "A note on\ntwo lines\n"

  • closed
    boolean

    Optional

    Whether the match report is closed.

    Example: false

  • user_id
    integer

    Optional

    The id of user

    Example: 513743143408302391

  • custom_user_identifier
    string

    Optional

    The custom user identifier

    Example: "acme:account:1234"

  • report
    object

    Optional

Response

[200] Participant update

Example
{
    "id": "168954615761461654",
    "type": "dispute",
    "closed": false,
    "closed_at": "2015-12-31T00:00:00+00:00",
    "closed_author_id": "513743143408302391",
    "note": "A note on\ntwo lines\n",
    "participant_id": "375143143408309123",
    "user_id": "513743143408302391",
    "custom_user_identifier": "acme:account:1234",
    "report": {
        "opponents": [
            {
                "score": 15,
                "number": 1,
                "result": "win",
                "forfeit": false
            }
        ]
    }
}
Structure (object)
  • id
    string

    The id of the match report.

    Example: "168954615761461654"

  • type
    string

    The type of the match report.

    Possible values: dispute, report

  • closed
    boolean

    Whether the match report is closed.

    Example: false

  • closed_at
    datetime|null

    The timestamp on which the match was played (a result was provided)

    Format: RFC 3339 (combined date, time and utc offset)

    Example: "2015-12-31T00:00:00+00:00"

  • closed_author_id
    integer|null

    The id of user who closed the report

    Example: 513743143408302391

  • note
    string|null

    Private note of a report, only visible by organizer.

    Example: "A note on\ntwo lines\n"

  • participant_id
    integer

    The id of participant

    Example: 375143143408309123

  • user_id
    integer

    The id of user

    Example: 513743143408302391

  • custom_user_identifier
    string

    The custom user identifier

    Example: "acme:account:1234"

  • report
    object