mirror of
https://github.com/mastodon/documentation
synced 2025-04-11 22:56:17 +02:00
ffbe66a389
* fix relrefs around trends and related entities * revert moving caption-links to middle of page * hide empty menu in table of contents * clarify edit notifs are only for boosted statuses * following/followers no longer need auth * fix typo * specify cooldown period for account Move * use the correct cooldown * add missing parameters to accounts/id/statuses * link to account_statuses_filter.rb * fix typo (#1072) * fix typo (#1073) * fix link to http sig spec (#1067) * simply HTTP request examples in api methods docs * add missing client_secret to oauth/token (#1062) * Add any, all, none to hashtag timeline * minor formatting changes * Update signature requirements and advice * fix public key -> private key * clarify use of RSA with SHA256 * Add note about saving your profile after adding rel-me link * v2 filters api * comment out params that shouldn't be used in v2 filter api * admin trends * remove old todo * canonical email blocks + scheduled statuses * remove under-construction warnings from finished pages * verify api method params with source code * fix typo (#1088) * fix broken caption-links (#1100) * fix formatting of entities (#1094) * Remove keybase section from user guide (#1093) * fix typos (#1092) * Verify limits are accurate (#1086) * add mention of iframe limitation (#1084) * Add CORS header to WEB_DOMAIN example (#1083) * Fix typo (#1081) * pin http sigs spec at draft 8 * Revert "pin http sigs spec at draft 8" This reverts commit 9fd5f7032b69b29e77599dd62adfe8d2f5cd4f20. * add case sensitivity warning to 4.0 roles * Add url length note to bio (#1087) * remove follow scope from examples (#1103) * clarify usage of update_credentials to update profile fields * add noindex to Account entitity * remove required hint from technically not required property
298 lines
8.2 KiB
Markdown
298 lines
8.2 KiB
Markdown
---
|
|
title: measures API methods
|
|
description: Obtain quantitative metrics about the server.
|
|
menu:
|
|
docs:
|
|
name: measures
|
|
parent: methods-admin
|
|
identifier: methods-admin-measures
|
|
aliases: [
|
|
"/methods/admin/measures",
|
|
"/api/methods/admin/measures",
|
|
]
|
|
---
|
|
|
|
<style>
|
|
#TableOfContents ul ul ul {display: none}
|
|
</style>
|
|
|
|
## Get measurable data {#get}
|
|
|
|
```http
|
|
POST /api/v1/admin/measures HTTP/1.1
|
|
```
|
|
|
|
Obtain statistical measures for your server.
|
|
|
|
**Returns:** Array of [Admin::Measure]({{< relref "entities/Admin_Measure" >}})\
|
|
**OAuth:** User token + `admin:read`\
|
|
**Permissions:** View Dashboard\
|
|
**Version history:**\
|
|
3.5.0 - added\
|
|
4.0.0 - support custom roles and permissions
|
|
|
|
#### Request
|
|
|
|
##### Headers
|
|
|
|
Authorization
|
|
: {{<required>}} Provide this header with `Bearer <user token>` to gain authorized access to this API method.
|
|
|
|
##### Form data parameters
|
|
|
|
keys[]
|
|
: {{<required>}} Array of String. Request specific measures by their keystring. Supported measures include:
|
|
- `active_users` = Total active users on your instance within the time period
|
|
- `new_users` = Users who joined your instance within the time period
|
|
- `interactions` = Total interactions (favourites, boosts, replies) on local statuses within the time period
|
|
- `opened_reports` = Total reports filed within the time period
|
|
- `resolved_reports` = Total reports resolved within the time period
|
|
- `tag_accounts` = Total accounts who used a tag in at least one status within the time period
|
|
- `tag_uses` = Total statuses which used a tag within the time period
|
|
- `tag_servers` = Total remote origin servers for statuses which used a tag within the time period
|
|
- `instance_accounts` = Total accounts originating from a remote domain within the time period
|
|
- `instance_media_attachments` = Total space used by media attachments from a remote domain within the time period
|
|
- `instance_reports` = Total reports filed against accounts from a remote domain within the time period
|
|
- `instance_statuses` = Total statuses originating from a remote domain within the time period
|
|
- `instance_follows` = Total accounts from a remote domain followed by a local user within the time period
|
|
- `instance_followers` = Total local accounts followed by accounts from a remote domain within the time period
|
|
|
|
start_at
|
|
: {{<required>}} String (ISO 8601 Datetime). The start date for the time period. If a time is provided, it will be ignored.
|
|
|
|
end_at
|
|
: {{<required>}} String (ISO 8601 Datetime). The end date for the time period. If a time is provided, it will be ignored.
|
|
|
|
tag_accounts[id]
|
|
: String. When `tag_accounts` is one of the requested keys, you must provide a tag ID to obtain the measure of how many accounts used that hashtag in at least one status within the given time period.
|
|
|
|
tag_uses[id]
|
|
: String. When `tag_uses` is one of the requested keys, you must provide a tag ID to obtain the measure of how many statuses used that hashtag within the given time period.
|
|
|
|
tag_servers[id]
|
|
: String. When `tag_servers` is one of the requested keys, you must provide a tag ID to obtain the measure of how many servers used that hashtag in at least one status within the given time period.
|
|
|
|
instance_accounts[domain]
|
|
: String. When `instance_accounts` is one of the requested keys, you must provide a remote domain to obtain the measure of how many accounts have been discovered from that server within the given time period.
|
|
|
|
instance_media_attachments[domain]
|
|
: String. When `instance_media_attachments` is one of the requested keys, you must provide a remote domain to obtain the measure of how much space is used by media attachments from that server within the given time period.
|
|
|
|
instance_reports[domain]
|
|
: String. When `instance_reports` is one of the requested keys, you must provide a remote domain to obtain the measure of how many reports have been filed against accounts from that server within the given time period.
|
|
|
|
instance_statuses[domain]
|
|
: String. When `instance_statuses` is one of the requested keys, you must provide a remote domain to obtain the measure of how many statuses originate from that server within the given time period.
|
|
|
|
instance_follows[domain]
|
|
: String. When `instance_follows` is one of the requested keys, you must provide a remote domain to obtain the measure of how many follows were performed on accounts from that server by local accounts within the given time period.
|
|
|
|
instance_followers[domain]
|
|
: String. When `instance_followers` is one of the requested keys, you must provide a remote domain to obtain the measure of how many follows were performed by accounts from that server on local accounts within the given time period.
|
|
|
|
#### Response
|
|
##### 200: OK
|
|
|
|
Returns quantitative data for each measure, in aggregate and also by data bucket.
|
|
|
|
```json
|
|
[
|
|
{
|
|
"key": "active_users",
|
|
"unit": null,
|
|
"total": "2",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00Z",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "new_users",
|
|
"unit": null,
|
|
"total": "2",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "interactions",
|
|
"unit": null,
|
|
"total": "0",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00Z",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "opened_reports",
|
|
"unit": null,
|
|
"total": "0",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "resolved_reports",
|
|
"unit": null,
|
|
"total": "0",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "tag_accounts",
|
|
"unit": null,
|
|
"total": "1",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00Z",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "tag_uses",
|
|
"unit": null,
|
|
"total": "2",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00Z",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "tag_servers",
|
|
"unit": null,
|
|
"total": "0",
|
|
"previous_total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "instance_accounts",
|
|
"unit": null,
|
|
"total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "instance_media_attachments",
|
|
"unit": "bytes",
|
|
"total": "0",
|
|
"human_value": "0 Bytes",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": ""
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "instance_reports",
|
|
"unit": null,
|
|
"total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "instance_statuses",
|
|
"unit": null,
|
|
"total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "instance_follows",
|
|
"unit": null,
|
|
"total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
},
|
|
{
|
|
"key": "instance_followers",
|
|
"unit": null,
|
|
"total": "0",
|
|
"data": [
|
|
{
|
|
"date": "2022-09-14T00:00:00.000+00:00",
|
|
"value": "0"
|
|
},
|
|
// ...
|
|
]
|
|
}
|
|
]
|
|
```
|
|
|
|
##### 403: Forbidden
|
|
|
|
Authorized user is missing a permission, or invalid or missing Authorization header
|
|
|
|
```json
|
|
{
|
|
"error": "This action is not allowed"
|
|
}
|
|
```
|
|
|
|
---
|
|
|
|
## See also
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/controllers/api/v1/admin/measures_controller.rb" caption="app/controllers/api/v1/admin/measures_controller.rb" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/lib/admin/metrics/measure.rb" caption="app/lib/admin/metrics/measure.rb" >}}
|
|
|
|
{{< caption-link url="https://github.com/mastodon/mastodon/blob/main/app/lib/admin/metrics/measure/" caption="app/lib/admin/metrics/measure/" >}} |