hyro/website
1
0
Fork 0
mirror of https://github.com/xHyroM/website.git synced 2024-11-10 01:38:05 +01:00
Code Issues Projects Releases Wiki Activity Actions

feat(docs/discord-experiments-api): add eligible docs

Browse source
This commit is contained in:
xHyroM 2023-06-03 22:26:28 +02:00
parent ca77ffa5d5
commit 5508468f14
No known key found for this signature in database
GPG key ID: BE0423F386C436AA
1 changed files with 53 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

53
docs/discord-experiments-api/eligible.md Normal file
View file

@ -0,0 +1,53 @@
---
title: Eligible
description: How to check if a guild is eligible for an experiment
---
# Eligible
This section of the documentation will cover how to check if a guild is eligible for an experiment.
Accessible on [https://api.discord-experiments.xhyrom.dev/v2/eligible](https://api.discord-experiments.xhyrom.dev/v2/eligible)
## Eligible Object
Represents the eligibility of a guild for an experiment
**Eligible Structure:**
| field | type | description |
| --------------------- | --------------------------------------------------------- | ------------------------------------------------------- |
| eligible | boolean | Whether the guild is eligible for the experiment or not |
| bucket * | [bucket](./experiments#population-bucket-object) | The bucket of the guild |
| filters | array of [filter](./experiments#population-filter-object) | The filters that haven't been checked |
| is_override_formatted | boolean | Whether the guild is in overrides_formatted |
\* Includes `id` field - id of the bucket
## Checking eligibility
You can check if a guild is eligible for an experiment by sending a POST request to [https://api.discord-experiments.xhyrom.dev/v2/eligible](https://api.discord-experiments.xhyrom.dev/v2/eligible)
**Body:**
| field | type | description |
| ------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------- |
| experiment_id | string | The id of the experiment to check eligibility for |
| guild * | [guild](https://discord.com/developers/docs/resources/guild#guild-object-guild-structure) | The guild to check eligibility for |
\* Only `id`, `features` and `member_count` fields are checked and `id` is required
```
POST https://api.discord-experiments.xhyrom.dev/v2/eligible
{
"experiment_id": "2023-03_clyde_ai",
"guild": {
"id": "1046534628577640528",
"features": ["COMMUNITY"],
"member_count": 100
}
}
```
Returns an [eligible object](#eligible-object)