> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/api-docs-contextual-information/match-info.md).

# Match Info

\[ Base URL: `api.ggwp.com`]

`POST` /data/v1/ingest

## **Description**

Reports any relevant information defining a new match event. This information is used to apply severity modifiers to incidents, to track player parties across time and to provide additional context when reviewing incidents or players in GGWP’s moderation tool.

## **Parameters**

`body`: Dictionary containing the following fields:

* **type**: `match-info`
* **session\_id**: unique identifier of the match.
* **session\_type**: string describing the match type or mode. Examples: `casual`, `competitive`, `custom`.
* **players**: list of all player participants and teams. Some relevant items would be:
  * **user\_id**: unique identifier of the user.
  * **username**: friendly display name.
  * **team\_id**: team identifier.
  * **party\_id**: identifier to connect the party of players that are queueing together.
  * **character\_name**: name of the character picked by the player.
  * **user\_level**: current player level.
* Sample Call

  ```bash
  curl --request POST 'https://api.ggwp.com/data/v1/ingest' \
  --header 'x-api-key: api_key' \
  --header 'Content-Type: application/json' \
  --data-raw '{
    "type": "match-info",
    "session_id": "<sessionID1>",
    "session_type": "competitive",
    "players": [
      {
        "user_id": "<id1>",
        "username": "nlxdz",
        "team_id": "1",
        "party_id": "1",
        "character_name": "Dracarys",
        "user_level": "50"
      },
      {
        "user_id" "<id2>",
        ...
      }
    ]
  }'
  ```

## **Output**

* 200 - successful operation

  ```json
  {
    "status": "success"
  }
  ```
* 400
  * Error response. The event has not been inserted into the system. This error is thrown in the following cases:
    * `Invalid Body. Expected JSON input`
      * Data payload is not JSON format
    * `Data payload too large`
      * Data payload exceeds 1MB in size
* 403
  * Invalid or missing API key.
* 500
  * Error response. The event has not been inserted into the system. There was some error on the server while processing the request.