Report API

The usage on report API v2.

Post Drop

POST https://penguin-stats.io/PenguinStats/api/v2/report

This endpoint allows you to submit drop sample.

Request Body

NameTypeDescription

server

string

Indicate the server of this drop sample. We support 4 servers now: "CN", "US", "JP" and "KR".

stageId

string

The stageId of this drop.

drops

array

An array of Drop. Please find its model below.

source

string

The source is used to mark the client sending this request. Equivalent to `User-Agent` presented in the header.

version

string

The version of the source.

{
  "reportHash": "49523605e1ab4774d1058d9caa25879c193226c9effee177fb3571a9f0e83e69"
}

Drop

Model

{
  dropType: string,
  itemId: string,
  quantity: number
}

Properties

dropType should be one of the four following values

  • NORMAL_DROP

  • SPECIAL_DROP

  • EXTRA_DROP

  • FURNITURE.

itemId is the internal id of item. It can be found in this repository.

quantity is the number of item dropped under this drop type. Must be positive.

Examples of Request Body

{
  "drops": [
    {
      "dropType": "SPECIAL_DROP",
      "itemId": "randomMaterial_3",
      "quantity": 1
    },
    {
      "dropType": "EXTRA_DROP",
      "itemId": "30061",
      "quantity": 2
    },
    {
      "dropType": "NORMAL_DROP",
      "itemId": "30013",
      "quantity": 1
    },
    {
      "dropType": "FURNITURE",
      "itemId": "furni",
      "quantity": 1
    }
  ],
  "stageId": "main_04-06",
  "server": "CN",
  "source": "CLIENT_SOURCE",
  "version": "CLIENT_VERSION"
}
{
  "drops": [
    {
      "dropType": "NORMAL_DROP",
      "itemId": "30063",
      "quantity": 1
    }
  ],
  "stageId": "main_06-14",
  "server": "US",
  "source": "CLIENT_SOURCE",
  "version": "CLIENT_VERSION"
}

Last updated