Skip to content

Add stats #125

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 14 commits into
base: master
Choose a base branch
from
27 changes: 27 additions & 0 deletions docs/account/stats/CollectionStats.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
## User Collection Stats (BULK)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think i would merge this with the regular stats bulk endpoint, with category as an optional query param


## Request
| URL | Method | Auth Required |
| - | - | - |
| https://statsproxy-public-service-live.ol.epicgames.com/statsproxy/api/statsv2/query | `POST` | Yes |

### Query

**category**: `collection_fish`, `collection_character`

## Body

```json
{
"appId": "Fortnite",
"startDate": 0,
"endDate": 9223372036854775807,
"owners": []
}
```

``startDate``: 0 (for alltime) or set for custom time-window

``endDate``: 9223372036854775807 (for alltime) or set for custom time-window
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wouldn't leaving out the endDate mean alltime?

i think it should also be documented what format those numbers have


``owners``: array of account ids (to get the stats from)
14 changes: 14 additions & 0 deletions docs/account/stats/Leaderboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Leaderboard status

## Request
| URL | Method | Auth Required |
| - | - | - |
| https://statsproxy-public-service-live.ol.epicgames.com/statsproxy/api/statsv2/leaderboards/:leaderboardName | `GET` | Yes |


**leaderboardName**:
``br_placetop1_keyboardmouse_m0_playlist_defaultsolo``

``br_placetop1_keyboardmouse_m0_playlist_defaultduo``

``br_placetop1_keyboardmouse_m0_playlist_defaultsquad`` (I think ONLY those work!)
9 changes: 9 additions & 0 deletions docs/account/stats/StatsV2.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# User Stats

## Request
| URL | Method | Auth Required |
| - | - | - |
| https://statsproxy-public-service-live.ol.epicgames.com/statsproxy/api/statsv2/account/:accountId | `GET` | Yes |

## Parameters
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

startDate and endDate are missing here

- `accountId`: target account id
20 changes: 20 additions & 0 deletions docs/account/stats/StatsV2Bulk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# User Stats

## Request
| URL | Method | Auth Required |
| - | - | - |
| https://statsproxy-public-service-live.ol.epicgames.com/statsproxy/api/statsv2/query | `POST` | Yes |

```json
{
"appId": "Fortnite",
"startDate": 0,
"endDate": 9223372036854775807,
"owners": ["accountId"],
"stats": ["s22_social_bp_level"]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

stats could be any stats key. you should probably put in a placeholder value and document it below

}
```

## Parameters
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

startDate and endDate should be documented aswell

- `owners`: Array of every Account Id to query
- `accountId`: Array of every Stat to query