# Quark

- [Introduction](https://docs.quark.bot/introduction.md): Welcome to Quark
- [Quickstart](https://docs.quark.bot/quickstart.md): Add Quark and get your first log in a few minutes
- [Overview](https://docs.quark.bot/overview.md): What Quark does
- [Permissions](https://docs.quark.bot/permissions.md): What Quark needs, and what stops working without each permission
- [Troubleshooting](https://docs.quark.bot/troubleshooting.md): Find out why logs are missing and fix it
- [Ideas](https://docs.quark.bot/ideas.md): Setups that other servers use to get more out of Quark
- [Overview](https://docs.quark.bot/dashboard/overview.md): A tour of the web dashboard
- [Automations](https://docs.quark.bot/dashboard/automations.md): Rules that do something extra when a log is produced
- [Sharing access](https://docs.quark.bot/dashboard/access.md): Give a role or a person part of the dashboard without giving them Manage Server
- [Overview](https://docs.quark.bot/logs/overview.md): What a log looks like and how Quark decides where to send it
- [Types](https://docs.quark.bot/logs/types.md): Every log type Quark can send, with its ID and category
- [Behaviour](https://docs.quark.bot/logs/behaviour.md): The rules Quark follows when deciding what to log and how
- [Options](https://docs.quark.bot/logs/options.md): Ignore rules and the other settings that decide what gets logged
- [Customization](https://docs.quark.bot/logs/customization.md): Change how your logs look and where each one goes
- [Log viewer](https://docs.quark.bot/logs/viewer.md): Read, filter and search your logs on the web
- [Search](https://docs.quark.bot/logs/search.md): Find an older log
- [Bot integrations](https://docs.quark.bot/logs/integrations.md): How Quark works alongside PluralKit and moderation bots
- [Overview](https://docs.quark.bot/commands/overview.md): What Quark commands are for
- [List](https://docs.quark.bot/commands/list.md): Every Quark command, who can use it, and its options
- [Behaviour](https://docs.quark.bot/commands/behaviour.md): The rules each command follows
- [Tags](https://docs.quark.bot/commands/tags.md): Saved answers your staff can post with one command
- [Overview](https://docs.quark.bot/subscriptions/overview.md): Quark Pro and Pro Lite: what they are and how to start using one
- [Comparison](https://docs.quark.bot/subscriptions/comparison.md): What each plan includes, side by side
- [Managing your plan](https://docs.quark.bot/subscriptions/manage.md): Change plan, move servers, cancel, and what happens when a plan ends
- [Voting](https://docs.quark.bot/subscriptions/voting.md): Unlock Pro Lite for free by voting for Quark on Top.gg
- [Overview](https://docs.quark.bot/data/overview.md): What data Quark handles and why
- [Behaviour](https://docs.quark.bot/data/behaviour.md): How long Quark keeps each kind of data, and how to remove it
- [Storage](https://docs.quark.bot/data/storage.md): How Quark protects the data it stores
- [Overview](https://docs.quark.bot/languages/overview.md): The languages Quark speaks and how to change yours
- [Start translating](https://docs.quark.bot/languages/start-translating.md): Contribute translations to Quark
- [Adding a new language](https://docs.quark.bot/languages/add-language.md): Add a language Quark does not have yet
- [Introduction](https://docs.quark.bot/api-reference/introduction.md): Configure Quark and read your logs from your own code
- [Get the whole configuration](https://docs.quark.bot/api-reference/configuration/get-the-whole-configuration.md): Returns every part of the server's Quark configuration in one response.
- [Get the server record](https://docs.quark.bot/api-reference/configuration/get-the-server-record.md): Returns Quark's record for the server.
- [Get server settings](https://docs.quark.bot/api-reference/configuration/get-server-settings.md): Returns the server's language setting.
- [Update server settings](https://docs.quark.bot/api-reference/configuration/update-server-settings.md): Changes the server's language.
- [Get log channels](https://docs.quark.bot/api-reference/log-channels/get-log-channels.md): Returns the channel each category of log is sent to.
- [Update log channels](https://docs.quark.bot/api-reference/log-channels/update-log-channels.md): Sets the main log channel or the channel for one or more categories. Include only the fields you want to change.
- [Get log channel load](https://docs.quark.bot/api-reference/log-channels/get-log-channel-load.md): Returns how many logs per minute are going to each log channel, compared with what Discord accepts. Use it to see whether a channel is over Discord's rate limit. The figures are estimates.
- [Get logging options](https://docs.quark.bot/api-reference/logging-settings/get-logging-options.md): Returns the server-wide logging options.
- [Update logging options](https://docs.quark.bot/api-reference/logging-settings/update-logging-options.md): Changes server-wide logging options. Include only the fields you want to change.
- [Get settings for log types](https://docs.quark.bot/api-reference/logging-settings/get-settings-for-log-types.md): Returns the settings of every log type that has been customised on this server, not only `log_id`. Pick the row whose `log_type` you want.
- [Update settings for a log type](https://docs.quark.bot/api-reference/logging-settings/update-settings-for-a-log-type.md): Changes the settings of one log type.
- [Get ignore options](https://docs.quark.bot/api-reference/ignore-options/get-ignore-options.md): Returns every ignore entry for the server, across all lists, not only `ignore_type`. Filter the result by `ignore_type` yourself.
- [Add an ignore entry](https://docs.quark.bot/api-reference/ignore-options/add-an-ignore-entry.md): Adds one entry to an ignore list.
- [Remove an ignore entry](https://docs.quark.bot/api-reference/ignore-options/remove-an-ignore-entry.md): Removes one entry from an ignore list. The entry to remove goes in the request body. Succeeds whether or not the entry existed.
- [Ignore the next logs about a target](https://docs.quark.bot/api-reference/active-ignore/ignore-the-next-logs-about-a-target.md): Asks Quark to leave out the next logs about one target: a member, message, channel, role or other thing a log is about. Send it just before, or just after, your bot does something you do not want logged.
- [Ignore the next logs of things done by a user](https://docs.quark.bot/api-reference/active-ignore/ignore-the-next-logs-of-things-done-by-a-user.md): Asks Quark to leave out the next logs of things done by one user, usually your own bot. Send it just before, or just after, the bot acts.
- [List tags](https://docs.quark.bot/api-reference/tags/list-tags.md): Returns every tag in the server.
- [Create a tag](https://docs.quark.bot/api-reference/tags/create-a-tag.md): Creates a tag. The new tag's ID is not returned. List the tags to find it.
- [Delete a tag](https://docs.quark.bot/api-reference/tags/delete-a-tag.md): Deletes a tag.
- [Update a tag](https://docs.quark.bot/api-reference/tags/update-a-tag.md): Changes a tag's content, colour or image. The name cannot be changed.
- [List logs](https://docs.quark.bot/api-reference/logs/list-logs.md): Returns the server's logs, newest first. This is the same data the log viewer shows.
- [List members in the logs](https://docs.quark.bot/api-reference/logs/list-members-in-the-logs.md): Returns the members who appear in the server's logs within the window its plan allows. Up to 2,000.
- [Export logs as CSV](https://docs.quark.bot/api-reference/logs/export-logs-as-csv.md): Returns the logs matching the filters as a CSV file, newest first, up to 50,000 rows, within the history window the server's plan allows.
- [List notifications](https://docs.quark.bot/api-reference/notifications/list-notifications.md): Returns the server's notifications: recent changes to Quark's configuration and who made them. These are what the bell on the dashboard shows.
- [Acknowledge all notifications](https://docs.quark.bot/api-reference/notifications/acknowledge-all-notifications.md): Marks every notification as read.
- [Acknowledge a notification](https://docs.quark.bot/api-reference/notifications/acknowledge-a-notification.md): Marks one notification as read.
- [Run the troubleshooter](https://docs.quark.bot/api-reference/troubleshooting/run-the-troubleshooter.md): Checks the server's configuration, Quark's permissions in each log channel and the delivery path, and returns what it found. This is the report `/troubleshoot` and the dashboard show.
- [Apply a fix](https://docs.quark.bot/api-reference/troubleshooting/apply-a-fix.md): Applies one of the automatic fixes from a troubleshooting report. Send the finding's `fix` object as the request body.
- [Send a test log](https://docs.quark.bot/api-reference/troubleshooting/send-a-test-log.md): Sends one real, visible test log through the full delivery path and reports whether it arrived. Limited to one per server per minute.
- [Search members or channels](https://docs.quark.bot/api-reference/search/search-members-or-channels.md): Searches the server's members or channels by name. Useful for turning a name into an ID before adding an ignore entry.
- [List API tokens](https://docs.quark.bot/api-reference/tokens/list-api-tokens.md): Returns a record of each API token for the server. The tokens themselves are never returned. Tokens are created on the dashboard.
- [Revoke an API token](https://docs.quark.bot/api-reference/tokens/revoke-an-api-token.md): Revokes a token. It stops working immediately.
- [Reset the server's configuration](https://docs.quark.bot/api-reference/server/reset-the-servers-configuration.md): Deletes Quark's entire configuration for the server: log channels, ignore options, per-log settings, automation rules, tags, dashboard access and the server's API token records. It also deletes the history of changes to modlog reasons. This cannot be undone.

## OpenAPI Specs

- [openapi](/api-reference/openapi.json)

## Optional

- [Website](https://quark.bot)
- [Support](https://quark.bot/support)
- [Status](https://status.quark.bot)
- [Changelog](https://quark.bot/changelog)
- [GitHub](https://quark.bot/github)
- [Invite](https://quark.bot/api/invite?source=docs)
- [Pricing](https://quark.bot/pricing)
- [Edit Docs](https://github.com/quark-bot-discord/docs)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.