# Arena Documentation

> Documentation for Arena

Append .md to any documentation page URL to get its markdown version.

## Guides
- [URL-Based Installation](https://docs.arena.im/docs/url-based-installation.md): By default, Arena generates a unique Comment System instance based on your page’s URL. This works out of the box for most websites with clean URLs (e.g., no `?p=123` , utms or tracking parameters).
- [Customizing URL Parameters](https://docs.arena.im/docs/advanced-installation-customizing-url-parameters.md): The URL-Based Installation works great for clean and structured URLs, but if your site uses query parameters (e.g., `?p=123` or `?utm_source=xyz`), you can customize how they affect the unique instance creation. This page explains the available parameters, when to use them, and provides examples.
- [Wordpress](https://docs.arena.im/docs/comment-system-wordpress-integration.md): Learn how to easily install the Comment System on WordPress using the Universal Snippet so it works across all pages.
- [Android Sdk](https://docs.arena.im/docs/android-sdk.md): Learn how to add the Comment System SDK to your Android app.
- [Add Android SDK to your app](https://docs.arena.im/docs/add-android-sdk-to-your-app.md)
- [Add iOS SDK to your app](https://docs.arena.im/docs/add-ios-sdk-to-your-app.md)
- [Add Flutter SDK to your app](https://docs.arena.im/docs/add-flutter-sdk-to-your-app.md): Learn how to add the CommentSystem SDK to your Flutter app.
- [Installation](https://docs.arena.im/docs/polls-installation.md): This guide explains how to install the Universal Snippet on your website and set up Pollls so it works properly.
- [Polls Ads Integration](https://docs.arena.im/docs/polls-ads-integration.md): This guide explains how to enable Ads inside your Polls widget using Arena's parameters.
- [Installation](https://docs.arena.im/docs/group-chat-installation.md): Arena’s Live Chat lets you create multiple unique chat instances tailored to your website or application. The Embed option is recommended for its flexibility across various page layouts.
- [Group Chat WordPress Plugin](https://docs.arena.im/docs/wordpress-plugin.md): In this article, we will cover how to install and use the Arena Grou Chat plugin in WordPress. Below, we provide a detailed step-by-step guide to explain how to set up and make the most of the Arena.im plugin on your WordPress site.
- [Android SDK](https://docs.arena.im/docs/android.md): Learn how to add the Chat SDK to your Android app.
- [Add Android SDK to your app](https://docs.arena.im/docs/add-the-chat-android-sdk-to-your-app.md)
- [Add iOS SDK to your app](https://docs.arena.im/docs/add-ios-sdk-to-your-app-1.md)
- [Installation](https://docs.arena.im/docs/instalation.md): Arena’s Live Blog lets you create multiple unique blog instances tailored to your website or application. The Embed option is recommended for its flexibility across various page layouts.
- [Arena Android SDK](https://docs.arena.im/docs/arena-android-sdk.md)
- [Google Helper](https://docs.arena.im/docs/google-helper.md)
- [Live Blog Wordpress Plugin](https://docs.arena.im/docs/wordpress-1.md): In this article, we will cover how to install and use the Arena plugin in WordPress. Below, we provide a detailed step-by-step guide to explain how to set up and make the most of the Arena.im plugin on your WordPress site.
- [SSO Comment System](https://docs.arena.im/docs/sso-comment-system.md): This guide explains how to integrate your website’s authentication system with the Arena Comments widget using a new secure SSO exchange route. This integration allows your authenticated users to automatically sign into Arena when they interact with the embedded widget on your site.
- [SSO Other Widgets](https://docs.arena.im/docs/sso-single-sign-on.md): Integrate your own authentication system with Arena to provide a seamless experience to your audience.
- [How Arena improves SEO](https://docs.arena.im/docs/how-arena-improves-seo.md): Learn how Arena improves your SEO ranking and how you can optimize it even further.

## API Reference
- [Retrieve All OAuth Tokens](https://docs.arena.im/reference/tokencontroller_findall.md): Fetches a list of all OAuth tokens associated with the authenticated user or client.
- [Create a New OAuth Token](https://docs.arena.im/reference/tokencontroller_create.md): Creates a new OAuth token using the provided API key token data.
- [Delete an OAuth Token by ID](https://docs.arena.im/reference/tokencontroller_delete.md): Deletes a specific OAuth token identified by its ID.
- [List All Organizations](https://docs.arena.im/reference/organizationcontroller_findall.md): Retrieves a list of all organizations accessible to the authenticated user.
- [Create a New Organization](https://docs.arena.im/reference/organizationcontroller_create.md): Creates a new organization using the provided organization data.
- [Get Organization by ID](https://docs.arena.im/reference/organizationcontroller_findone.md): Retrieves a single organization by its ID.
- [Update an Organization](https://docs.arena.im/reference/organizationcontroller_update.md): Updates an existing organization identified by its ID using the provided data.
- [Delete an Organization](https://docs.arena.im/reference/organizationcontroller_delete.md): Deletes a specific organization identified by its ID.
- [Create a New Site](https://docs.arena.im/reference/sitecontroller_create.md): Creates a new site within the specified organization using the provided site data.
- [List Sites for an Organization](https://docs.arena.im/reference/sitecontroller_findall.md): Retrieves a paginated list of sites associated with the specified organization, with optional filtering and sorting.
- [Get Site by ID](https://docs.arena.im/reference/findonesite.md): Retrieves a single site by its ID within the specified organization.
- [Update a Site](https://docs.arena.im/reference/sitecontroller_update.md): Updates an existing site within the specified organization using the provided site data.
- [Partially Update a Site](https://docs.arena.im/reference/sitecontroller_patch.md): Partially updates an existing site within the specified organization using the provided patch data.
- [Delete a Site](https://docs.arena.im/reference/sitecontroller_delete.md): Deletes a specific site identified by its ID within the specified organization.
- [Retrieve All Actions for a Site](https://docs.arena.im/reference/actioncontroller_findall.md): Fetches a paginated list of all actions associated with a specific site.
- [Create an Action for a Site](https://docs.arena.im/reference/actioncontroller_create.md): Creates a new action for a specific site using the provided action data.
- [Retrieve a Specific Action by ID](https://docs.arena.im/reference/actioncontroller_findone.md): Fetches the details of a specific action within a site using its ID.
- [Retrieve All Tags for a Site](https://docs.arena.im/reference/tagcontroller_findall.md): Fetches a paginated list of all tags associated with a specific site.
- [Create a Stream Template for a Site](https://docs.arena.im/reference/streamtemplatecontroller_create.md): Creates a new stream template for a specific site using the provided template data.
- [Retrieve All Stream Templates for a Site](https://docs.arena.im/reference/streamtemplatecontroller_findall.md): Fetches a list of all stream templates associated with a specific site.
- [Update a Stream Template by ID](https://docs.arena.im/reference/streamtemplatecontroller_update.md): Fully updates an existing stream template within a site using the provided template data.
- [Retrieve a Specific Stream Template by ID](https://docs.arena.im/reference/streamtemplatecontroller_findone.md): Fetches the details of a specific stream template within a site using its ID.
- [Delete a Stream Template by ID](https://docs.arena.im/reference/streamtemplatecontroller_deleteone.md): Deletes a specific stream template within a site using its ID.
- [Retrieve All Dashboard Users for a Site](https://docs.arena.im/reference/dashboardusercontroller_findall.md): Fetches a paginated and optionally sorted list of all dashboard users associated with a specific site.
- [Create a User for a Site](https://docs.arena.im/reference/usercontroller_create.md): Creates a new user associated with the specified site using the provided user data.
- [Retrieve a User by ID](https://docs.arena.im/reference/usercontroller_findone.md): Fetches the details of a specific user within a site using the user's unique ID.
- [List Users for a Site](https://docs.arena.im/reference/usercontroller_findall.md): Retrieves a paginated list of users associated with a specific site, with optional pagination and sorting to customize the results.
- [Partially Update a User](https://docs.arena.im/reference/usercontroller_update.md): Partially updates the details of an existing user within a site using the provided patch data.
- [Retrieve Grouped Page Views Analytics](https://docs.arena.im/reference/analyticscontroller_findall.md): Fetches a paginated list of page view analytics grouped by specified criteria, with filtering and sorting options.
- [Create a Blog for a Site](https://docs.arena.im/reference/blogcontroller_create.md): Creates a new blog associated with the specified site using the provided blog data.
- [List Blogs for a Site](https://docs.arena.im/reference/blogcontroller_findall.md): Retrieves a paginated list of blogs associated with a specific site, with optional filtering, pagination, and sorting.
- [Retrieve a Blog by ID or Slug](https://docs.arena.im/reference/blogcontroller_findone.md): Fetches the details of a specific blog within a site using its unique ID or slug.
- [Retrieve Blog Lineup](https://docs.arena.im/reference/blogcontroller_findlineup.md): Fetches the lineup details for a specific blog within a site, identified by its unique ID or slug.
- [Update a Blog](https://docs.arena.im/reference/blogcontroller_update.md): Fully updates the details of an existing blog within a site using the provided blog data.
- [Delete a Blog](https://docs.arena.im/reference/blogcontroller_delete.md): Deletes a specific blog within a site by its unique ID or slug.
- [Create a Post in a Blog](https://docs.arena.im/reference/postcontroller_create.md): Creates a new post within a specified blog using the provided post data.
- [Retrieve All Posts](https://docs.arena.im/reference/retrieve-all-posts.md)
- [Retrieve a Specific Post by ID](https://docs.arena.im/reference/postcontroller_findone.md): Fetches the details of a specific post within a blog using its ID.
- [Update a Post by ID](https://docs.arena.im/reference/postcontroller_update.md): Fully updates an existing post within a blog using the provided post data.
- [Partially Update a Post by ID](https://docs.arena.im/reference/postcontroller_patch.md): Partially updates an existing post within a blog using the provided patch data.
- [Delete a Post by ID](https://docs.arena.im/reference/postcontroller_delete.md): Deletes a specific post within a blog using its ID.
- [Create a Poll for a Blog Post](https://docs.arena.im/reference/postcontroller_createpoll.md): Creates a new poll associated with a blog post using the provided poll data.
- [[Public] Retrieve a Specific Public Post by ID](https://docs.arena.im/reference/publiccontroller_findonepost.md): Fetches the details of a specific publicly accessible post within a blog using its ID.
- [[Public] Retrieve All Public Posts in a Blog](https://docs.arena.im/reference/publiccontroller_findallposts.md): Fetches a paginated list of all publicly accessible posts within a specific blog, with optional filtering by tags and pagination starting point.
- [Create Blog Streams from a Stream Template](https://docs.arena.im/reference/streamtemplatecontroller_createblogstreamsfromtemplate.md): Creates blog streams for a specific site based on a given stream template ID and provided data.
- [Create a Chat for a Site](https://docs.arena.im/reference/chatcontroller_create.md): Creates a new chat associated with the specified site using the provided chat data.
- [List Chats for a Site](https://docs.arena.im/reference/chatcontroller_findall.md): Retrieves a paginated list of chats associated with a specific site, with optional pagination and sorting.
- [Retrieve a Chat by ID](https://docs.arena.im/reference/chatcontroller_findone.md): Fetches the details of a specific chat within a site by its unique ID.
- [Update a Chat](https://docs.arena.im/reference/chatcontroller_update.md): Fully updates the details of an existing chat within a site using the provided chat data.
- [Partially Update a Chat](https://docs.arena.im/reference/chatcontroller_patch.md): Partially updates the details of an existing chat within a site using the provided patch data.
- [Delete a Chat](https://docs.arena.im/reference/chatcontroller_delete.md): Deletes a specific chat within a site by its unique ID.
- [Create a Channel for a Chat](https://docs.arena.im/reference/channelcontroller_create.md): Creates a new channel within the specified chat using the provided channel data.
- [List Channels for a Chat](https://docs.arena.im/reference/channelcontroller_findall.md): Retrieves a paginated list of channels associated with a specific chat, with optional filtering, pagination, and sorting.
- [Retrieve a Channel by ID](https://docs.arena.im/reference/channelcontroller_findone.md): Fetches the details of a specific channel within a chat by its unique ID.
- [Update a Channel](https://docs.arena.im/reference/channelcontroller_update.md): Fully updates the details of an existing channel within a chat using the provided channel data.
- [Partially Update a Channel](https://docs.arena.im/reference/channelcontroller_patch.md): Partially updates the details of an existing channel within a chat using the provided patch data.
- [Delete a Channel](https://docs.arena.im/reference/channelcontroller_delete.md): Deletes a specific channel within a chat by its unique ID.
- [Create a Message in a Channel](https://docs.arena.im/reference/messagecontroller_create.md): Creates a new message within the specified channel using the provided message data.
- [List of group chat messages](https://docs.arena.im/reference/list-of-group-chat-messages.md): List of group chat messages
- [Retrieve a Message by ID](https://docs.arena.im/reference/messagecontroller_findone.md): Fetches the details of a specific message within a channel by its unique ID.
- [Delete a Message](https://docs.arena.im/reference/messagecontroller_delete.md): Deletes a specific message within a channel by its unique ID.
- [Create a Poll in a Channel](https://docs.arena.im/reference/pollcontroller_create.md): Creates a new poll within a specified channel using the provided poll data.
- [Retrieve All Polls in a Channel](https://docs.arena.im/reference/pollcontroller_findall.md): Fetches a paginated and optionally sorted list of all polls within a specific channel.
- [Retrieve a Specific Poll by ID](https://docs.arena.im/reference/pollcontroller_findone.md): Fetches the details of a specific poll within a channel using its ID.
- [Update a Poll by ID](https://docs.arena.im/reference/pollcontroller_update.md): Fully updates an existing poll within a channel using the provided poll data.
- [Partially Update a Poll by ID](https://docs.arena.im/reference/pollcontroller_patch.md): Partially updates an existing poll within a channel using the provided patch data.
- [Delete a Poll by ID](https://docs.arena.im/reference/pollcontroller_delete.md): Deletes a specific poll within a channel using its ID.
- [List Reports for a Message](https://docs.arena.im/reference/messagereportcontroller_findall.md): Retrieves a paginated list of reports associated with a specific message in a channel, with optional pagination.
- [Create a Report for a Message](https://docs.arena.im/reference/messagereportcontroller_create.md): Creates a new report for a specific message within a channel using the provided report data.
- [Delete Reports for a Message](https://docs.arena.im/reference/messagereportcontroller_delete.md): Deletes all reports associated with a specific message within a channel.
- [Create a Moderator for a Site](https://docs.arena.im/reference/moderatorcontroller_create.md): Creates a new moderator for a specific site using the provided moderator data.
- [Retrieve All Moderators for a Site](https://docs.arena.im/reference/moderatorcontroller_findall.md): Fetches a paginated list of all moderators associated with a specific site.
- [Retrieve a Specific Moderator by ID](https://docs.arena.im/reference/moderatorcontroller_findone.md): Fetches the details of a specific moderator within a site using its ID.
- [Partially Update a Moderator by ID](https://docs.arena.im/reference/moderatorcontroller_patch.md): Partially updates an existing moderator within a site using the provided patch data.
- [Update a Moderator by ID](https://docs.arena.im/reference/moderatorcontroller_update.md): Fully updates an existing moderator within a site using the provided moderator data.
- [Delete a Moderator by ID](https://docs.arena.im/reference/moderatorcontroller_delete.md): Deletes a specific moderator within a site using its ID.
- [Create a Ban for a Site](https://docs.arena.im/reference/bancontroller_create.md): Creates a new ban for a specific site using the provided ban data.
- [Retrieve All Bans for a Site](https://docs.arena.im/reference/bancontroller_findall.md): Fetches a paginated list of all bans associated with a specific site.
- [Retrieve a Specific Ban by ID](https://docs.arena.im/reference/bancontroller_findone.md): Fetches the details of a specific ban within a site using its ID.
- [Delete a Ban by ID](https://docs.arena.im/reference/bancontroller_delete.md): Deletes a specific ban within a site using its ID.
- [Create Profanity List for a Site and Language](https://docs.arena.im/reference/profanitycontroller_create.md): Creates a new profanity list for a specific site and language using the provided profanity data.
- [Retrieve Profanity List by Site and Language](https://docs.arena.im/reference/profanitycontroller_findone.md): Fetches the profanity list for a specific site and language.
- [Delete Profanity List by Site and Language](https://docs.arena.im/reference/profanitycontroller_delete.md): Deletes the profanity list for a specific site and language.
- [Retrieve All Profanity Lists for a Site](https://docs.arena.im/reference/profanitycontroller_findall.md): Fetches a paginated list of all profanity lists associated with a specific site.
- [Upload a File for a Site](https://docs.arena.im/reference/contentmanagercontroller_create.md): Uploads a new file to the content manager for a specific site using the provided file data.
- [Retrieve All Sports](https://docs.arena.im/reference/sportcontroller_findall.md): Fetches a list of all available sports.
- [Retrieve All Tournaments for a Sport](https://docs.arena.im/reference/sportcontroller_findalltournaments.md): Fetches a paginated list of tournaments for a specific sport, with optional filtering by name or site.
- [Comment count for a thread](https://docs.arena.im/reference/comment-count-for-a-thread.md): Search for the number of comments on a url or on a page with a customized comment topic id
- [Retrieve Commerce AI Analytics](https://docs.arena.im/reference/commerceaicontroller_getanalytics.md): Fetches analytics data for a specific Commerce AI instance within a site, filtered by a date period.