QUquark-bot-discord
Logs

List logs

Changed on

Returns the server's logs, newest first. This is the same data the log viewer shows.

How far back you can read depends on the server's plan: the last hour on the free plan and Pro Lite, 30 days on Quark Pro. A request that reaches further back is cut to that window and walled is true.

get/servers/{guild_id}/logs

Request

Path parameters

guild_idstring required
Example:301655085954367490

The server's ID. Must be the server the token was created for.

Query parameters

searchstring

Text to search for. Matches whole words in message content, and parts of names, channels, roles and reasons.

afterinteger

Only entries after this time, in milliseconds since the Unix epoch. Limited to what the server's plan allows.

beforeinteger

Only entries before this time, in milliseconds since the Unix epoch.

categorystring[]

One or more categories. Repeat the parameter for each.

typeinteger[]

One or more log type IDs. Repeat the parameter for each.

channelstring

A channel ID.

memberstring

A user ID.

memberRole'executor' | 'target' | 'either'

Whether member did the action, had it done to them, or either.

rolestring

A role name, or part of one.

limitinteger

Entries per page.

cursorstring

The cursor from the previous page.

bot'pro'

Set to pro to act on the Quark Pro bot's configuration. Leave out for the main Quark bot.

Response

A page of logs.

totalinteger

How many entries match the filters from this page onwards. On the first page it is the total number of matches.

retentionMsinteger

How far back this server's plan lets you read, in milliseconds.

walledboolean

True if the request asked for more history than the plan allows.

cursorstring nullable

Pass this as cursor to get the next page. Null when there are no more.

categoryCountsobject

Number of entries in each category that match the other filters. The category filter itself is not applied.

Changes

  • 9b9591ac8b29Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • dac8d050ac15Revision changes
    • info

      added the optional property // to the response with the status