charts/instance
POSTAPIの概要 実装を見る
No description provided.
Credential required: No
パラメータ
| 名前 | 型 | 既定値 | |
|---|---|---|---|
| 必須 | span | 文字列 | - |
| limit | 整数 | 30 | |
| 任意 | offset | 整数 | - |
| 必須 | host | 文字列 | - |
200 レスポンス リクエスト成功（内容あり）
| 名前 | 型 | 例 | |
|---|---|---|---|
| requests.failed | 配列（内容: 数字） | - | |
| requests.succeeded | 配列（内容: 数字） | - | |
| requests.received | 配列（内容: 数字） | - | |
| notes.total | 配列（内容: 数字） | - | |
| notes.inc | 配列（内容: 数字） | - | |
| notes.dec | 配列（内容: 数字） | - | |
| notes.diffs.normal | 配列（内容: 数字） | - | |
| notes.diffs.reply | 配列（内容: 数字） | - | |
| notes.diffs.renote | 配列（内容: 数字） | - | |
| notes.diffs.withFile | 配列（内容: 数字） | - | |
| users.total | 配列（内容: 数字） | - | |
| users.inc | 配列（内容: 数字） | - | |
| users.dec | 配列（内容: 数字） | - | |
| following.total | 配列（内容: 数字） | - | |
| following.inc | 配列（内容: 数字） | - | |
| following.dec | 配列（内容: 数字） | - | |
| followers.total | 配列（内容: 数字） | - | |
| followers.inc | 配列（内容: 数字） | - | |
| followers.dec | 配列（内容: 数字） | - | |
| drive.totalFiles | 配列（内容: 数字） | - | |
| drive.incFiles | 配列（内容: 数字） | - | |
| drive.decFiles | 配列（内容: 数字） | - | |
| drive.incUsage | 配列（内容: 数字） | - | |
| drive.decUsage | 配列（内容: 数字） | - | |
400 エラー クライアント側エラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
401 エラー 認証エラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
403 エラー 権限関連のエラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
418 エラー I'm Ai
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
500 エラー サーバー内部エラー
| 名前 | 型 | 例 | |
|---|---|---|---|
| なし | |||
{
"_path": "/api-docs/endpoints/charts/instance",
"_dir": "charts",
"_draft": false,
"_partial": false,
"_locale": "",
"data": {
"post": {
"operationId": "charts/instance",
"summary": "charts/instance",
"description": "No description provided.\n\n**Credential required**: *No*",
"externalDocs": {
"description": "Source code",
"url": "https://github.com/misskey-dev/misskey/blob/develop/packages/backend/src/server/api/endpoints/charts/instance.ts"
},
"tags": [
"charts"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"span": {
"type": "string",
"enum": [
"day",
"hour"
]
},
"limit": {
"type": "integer",
"minimum": 1,
"maximum": 500,
"default": 30
},
"offset": {
"type": "integer",
"nullable": true,
"default": null
},
"host": {
"type": "string"
}
},
"required": [
"span",
"host"
]
}
}
}
},
"responses": {
"200": {
"description": "OK (with results)",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"requests.failed": {
"type": "array",
"items": {
"type": "number"
}
},
"requests.succeeded": {
"type": "array",
"items": {
"type": "number"
}
},
"requests.received": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.total": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.inc": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.dec": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.diffs.normal": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.diffs.reply": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.diffs.renote": {
"type": "array",
"items": {
"type": "number"
}
},
"notes.diffs.withFile": {
"type": "array",
"items": {
"type": "number"
}
},
"users.total": {
"type": "array",
"items": {
"type": "number"
}
},
"users.inc": {
"type": "array",
"items": {
"type": "number"
}
},
"users.dec": {
"type": "array",
"items": {
"type": "number"
}
},
"following.total": {
"type": "array",
"items": {
"type": "number"
}
},
"following.inc": {
"type": "array",
"items": {
"type": "number"
}
},
"following.dec": {
"type": "array",
"items": {
"type": "number"
}
},
"followers.total": {
"type": "array",
"items": {
"type": "number"
}
},
"followers.inc": {
"type": "array",
"items": {
"type": "number"
}
},
"followers.dec": {
"type": "array",
"items": {
"type": "number"
}
},
"drive.totalFiles": {
"type": "array",
"items": {
"type": "number"
}
},
"drive.incFiles": {
"type": "array",
"items": {
"type": "number"
}
},
"drive.decFiles": {
"type": "array",
"items": {
"type": "number"
}
},
"drive.incUsage": {
"type": "array",
"items": {
"type": "number"
}
},
"drive.decUsage": {
"type": "array",
"items": {
"type": "number"
}
}
},
"required": [
"requests.failed",
"requests.succeeded",
"requests.received",
"notes.total",
"notes.inc",
"notes.dec",
"notes.diffs.normal",
"notes.diffs.reply",
"notes.diffs.renote",
"notes.diffs.withFile",
"users.total",
"users.inc",
"users.dec",
"following.total",
"following.inc",
"following.dec",
"followers.total",
"followers.inc",
"followers.dec",
"drive.totalFiles",
"drive.incFiles",
"drive.decFiles",
"drive.incUsage",
"drive.decUsage"
]
}
}
}
},
"400": {
"description": "Client error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"INVALID_PARAM": {
"value": {
"error": {
"message": "Invalid param.",
"code": "INVALID_PARAM",
"id": "3d81ceae-475f-4600-b2a8-2bc116157532"
}
}
}
}
}
}
},
"401": {
"description": "Authentication error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"CREDENTIAL_REQUIRED": {
"value": {
"error": {
"message": "Credential required.",
"code": "CREDENTIAL_REQUIRED",
"id": "1384574d-a912-4b81-8601-c7b1c4085df1"
}
}
}
}
}
}
},
"403": {
"description": "Forbidden error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"AUTHENTICATION_FAILED": {
"value": {
"error": {
"message": "Authentication failed. Please ensure your token is correct.",
"code": "AUTHENTICATION_FAILED",
"id": "b0a7f5f8-dc2f-4171-b91f-de88ad238e14"
}
}
}
}
}
}
},
"418": {
"description": "I'm Ai",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"I_AM_AI": {
"value": {
"error": {
"message": "You sent a request to Ai-chan, Misskey's showgirl, instead of the server.",
"code": "I_AM_AI",
"id": "60c46cd1-f23a-46b1-bebe-5d2b73951a84"
}
}
}
}
}
}
},
"500": {
"description": "Internal server error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Error"
},
"examples": {
"INTERNAL_ERROR": {
"value": {
"error": {
"message": "Internal error occurred. Please contact us if the error persists.",
"code": "INTERNAL_ERROR",
"id": "5d37dbcb-891e-41ca-a3d6-e690c97775ac"
}
}
}
}
}
}
}
}
}
},
"title": "charts/instance",
"_id": "content:api-docs:endpoints:charts:instance.json",
"_type": "json",
"_source": "content",
"_file": "api-docs/endpoints/charts/instance.json",
"_extension": "json"
}