jointrashposs/content/ja/.docs-legacy/api/endpoints/notes/global-timeline.json5
2023-07-11 23:48:17 +09:00

64 lines
1.8 KiB
Plaintext
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

{
summary: 'グローバルタイムライン (GTL) を取得します。',
description: 'グローバルタイムライン (GTL) を取得します。グローバルタイムラインは、サーバーが受信した全てのパブリックな投稿が含まれます。',
tags: [
'notes',
],
requireCredential: false,
req: {
type: 'object',
properties: {
withFiles: {
type: 'boolean',
default: false,
description: 'trueにすると、ファイルが添付されたートのみを取得します。',
},
limit: {
type: 'integer',
minimum: 1,
maximum: 100,
default: 10,
description: '取得するノートの最大数。',
},
sinceId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも大きいートを返します。',
},
untilId: {
type: 'string',
format: 'misskey:id',
description: '指定すると、idがその値よりも小さいートを返します。',
},
sinceDate: {
type: 'integer',
description: 'エポック秒で日時を指定すると、その日時より後に作成されたノートを返します。',
},
untilDate: {
type: 'integer',
description: 'エポック秒で日時を指定すると、その日時より前に作成されたノートを返します。',
},
},
required: [],
},
res: {
type: 'array',
optional: false,
nullable: false,
items: {
type: 'object',
optional: false,
nullable: false,
ref: 'Note',
$ref: 'misskey://Note',
},
},
errors: {
'0332fc13-6ab2-4427-ae80-a9fadffd1a6b': {
id: '0332fc13-6ab2-4427-ae80-a9fadffd1a6b',
code: 'GTL_DISABLED',
description: 'グローバルタイムラインが無効になっています。',
},
},
}