# Swonkie API

## Docs
- [Introduction](https://docs.swonkie.dev/introduction-359593m0.md): 
- [Quick Start](https://docs.swonkie.dev/quick-start.md): 
- [Changelog](https://docs.swonkie.dev/changelog.md): 
- Social Networks [Facebook](https://docs.swonkie.dev/social-networks/facebook.md): 
- Social Networks [Instagram](https://docs.swonkie.dev/social-networks/instagram.md): 
- Social Networks [LinkedIn](https://docs.swonkie.dev/social-networks/linkedin.md): 
- Social Networks [TikTok](https://docs.swonkie.dev/social-networks/tiktok.md): 
- Social Networks [Threads](https://docs.swonkie.dev/social-networks/threads.md): 
- [Profiles](https://docs.swonkie.dev/profiles-502246f0.md): **Profiles** allows you to list your connected social profiles and tracked competitors. It provides visibility into connection status and health, helping you ensure your profiles are correctly set up and up to date.
- [Insights](https://docs.swonkie.dev/insights-502247f0.md): **Insights** gives you direct access to the raw data behind Swonkie’s insights, metrics and dashboards. You can retrieve daily metrics such as followers, detailed lists of posts and engagement data like interactions, for both your own profiles and tracked competitors.
- Insights [Getting Started](https://docs.swonkie.dev/getting-started-359596m0.md): 
- [Posts](https://docs.swonkie.dev/posts-502248f0.md): The Posts API provides comprehensive management of your social media content across multiple networks and profiles. A single post entity in Swonkie represents a unified piece of content that can be distributed to dozens of individual social media posts simultaneously, each tailored to the specific requirements and features of different platforms.
- Posts [Getting Started](https://docs.swonkie.dev/getting-started-359597m0.md): 
- [Labels](https://docs.swonkie.dev/labels-502249f0.md): The Labels API allows you to create and manage organizational tags for your posts. Labels provide a flexible way to categorize, filter, and organize your content calendar without rigid hierarchies or limitations.
- Labels [Getting Started](https://docs.swonkie.dev/getting-started-359598m0.md): 
- [Media](https://docs.swonkie.dev/media-502250f0.md): The media workflow:
- [Examples](https://docs.swonkie.dev/examples.md): 
- Examples [Publish](https://docs.swonkie.dev/examples/publish.md): 

## API Docs
- Profiles [My Profiles](https://docs.swonkie.dev/my-profiles-4106572e0.md): Retrieves a paginated list of all connected social media profiles in your workspace. This endpoint allows you to search and filter your authenticated social network accounts, view their connection status, and access basic profile information across multiple platforms.
- Profiles [Competitors](https://docs.swonkie.dev/competitors-4106573e0.md): Retrieves a paginated list of all competitor profiles being monitored in your workspace. This endpoint allows you to track and analyze competitor social media accounts across multiple platforms, view their monitoring status, and access basic profile information for competitive intelligence purposes.
- Insights [My Profile Insights](https://docs.swonkie.dev/my-profile-insights-4106574e0.md): Retrieves daily aggregated insights and metrics for one of your connected social media profiles over a specified date range. This endpoint provides analytics data such as followers, impressions, reach, engagement, and other network-specific metrics that are tracked on a daily basis. Each social network has its own set of available metrics that you can request.  
- Insights [My Profile Insights Posts](https://docs.swonkie.dev/my-profile-insights-posts-4106575e0.md): Retrieves post-level insights and metrics for one of your connected social media profiles over a specified date range. This endpoint provides detailed analytics for individual posts, including engagement metrics, reach, impressions, and other post-specific data. You can request metrics that apply to all posts (like likes, comments) or network-specific metrics (like Facebook reactions, Instagram saves).  
- Insights [Competitor Insights](https://docs.swonkie.dev/competitor-insights-4106576e0.md): Retrieves daily aggregated insights and metrics for one of your monitored competitor profiles over a specified date range. This endpoint provides analytics data such as followers, engagement, and other publicly available metrics that are tracked on a daily basis. The available metrics depend on what data the social network makes publicly accessible for competitor analysis.  
- Insights [Competitor Insights Posts](https://docs.swonkie.dev/competitor-insights-posts-4106577e0.md): Retrieves post-level insights and metrics for one of your monitored competitor profiles over a specified date range. This endpoint provides detailed analytics for individual competitor posts, including publicly available engagement metrics such as likes, comments, shares, and views. The available metrics are limited to what the social network makes publicly accessible without authentication.  
- Posts [List Posts](https://docs.swonkie.dev/list-posts-4106578e0.md): Retrieves a paginated list of posts from your workspace. This endpoint allows you to filter posts by various criteria including stage, type, profiles, labels, date range, and search terms. Use this to manage your content calendar, track post statuses, and retrieve post details for scheduling and publishing.
- Posts [Get a Post](https://docs.swonkie.dev/get-a-post-4106579e0.md): Retrieves detailed information about a specific post by its ID. This endpoint returns the complete post data including all configurations, media, captions, labels, and network-specific settings. Use this to view or edit a single post's details.
- Posts [Create a Post](https://docs.swonkie.dev/create-a-post-4106580e0.md): Creates a new post in your workspace. This endpoint allows you to create posts across multiple social networks with customizable content, media, scheduling, and network-specific settings. Posts can be created as ideas (without a publish date) or drafts (with a scheduled publish date). The post will be validated before creation to ensure all content meets the requirements of the selected social networks.
- Posts [Update a Post](https://docs.swonkie.dev/update-a-post-4106581e0.md): Updates an existing post in your workspace. This endpoint allows you to modify post content, media, scheduling, profiles, labels, and network-specific settings. The post will be validated before updating to ensure all changes meet the requirements of the selected social networks. You can update any field of the post, and only the fields you provide will be modified.
- Posts [Validate a Post](https://docs.swonkie.dev/validate-a-post-4106582e0.md): Validates a post before publishing to ensure all content meets the requirements of the selected social networks. This endpoint performs the same validation checks that occur during the actual publishing process, allowing you to catch issues early without attempting to publish. Use this to verify that your post is ready to be scheduled or published immediately.
- Posts [Delete a Post](https://docs.swonkie.dev/delete-a-post-4106583e0.md): Deletes a post from your workspace. This action is permanent and cannot be undone. The post must belong to your workspace and must not be in certain protected stages (e.g., currently publishing). Once deleted, all associated data including captions, media assignments, labels, and network-specific configurations will be removed.
- Posts [Change Post Stage](https://docs.swonkie.dev/change-post-stage-4106584e0.md): Changes the stage/status of a post in your workspace workflow. This endpoint allows you to move posts through different stages of the approval and publishing process. Use this to publish posts immediately, schedule them for later, submit for team review, approve or reject posts, or unschedule previously scheduled posts.
- Labels [List Labels](https://docs.swonkie.dev/list-labels-4106585e0.md): Retrieves a paginated list of all labels (tags) in your workspace. Labels are used to organize and categorize posts, making it easier to filter and manage your content calendar. Each label has a name and an optional color for visual identification in the interface.
- Labels [Create a Label](https://docs.swonkie.dev/create-a-label-4106586e0.md): Creates a new label (tag) in your workspace. Labels are used to organize and categorize posts, making it easier to filter and manage your content calendar. Once created, labels can be assigned to posts to help with organization and filtering.
- Media [Get a Media](https://docs.swonkie.dev/get-a-media-4106587e0.md): Retrieves detailed information about a specific media file from your workspace's media library. This endpoint returns metadata about the media including its URL, preview, type, dimensions, file size, and processing status. Use this to verify media uploads or retrieve media details for display purposes.
- Media [Create a Media](https://docs.swonkie.dev/create-a-media-4106588e0.md): Creates a new media entry in your workspace's media library and provides a temporary upload URL for uploading the actual file. This is a tree-step process: first you create the media entry with this endpoint to receive an upload URL, then you upload your file to that URL using a PUT request, finally you request `PATCH /media/:mediaId` to confirm the upload has finished. Once uploaded, the file will be processed asynchronously, and you can check its status using `GET /media/:mediaId`.
- Media [Upload File to Media](https://docs.swonkie.dev/upload-file-to-media-4106589e0.md): Using the `uploadUrl` generated from the `POST /media` request, perform a request with the following documented **Headers** and **Body** in order to complete the process.
- Media [Confirm Uploaded Media](https://docs.swonkie.dev/confirm-uploaded-media-4129233e0.md): Once you finish uploading the file using the `PUT {uploadUrl}`, you must use the mediaId generated from the `POST /media` request to perform this request to confirm the media has been sucessfully uploaded.
- Media [Delete a Media](https://docs.swonkie.dev/delete-a-media-4106590e0.md): Deletes a media file from your workspace's media library. This action is permanent and cannot be undone. The media file and all its associated data (preview, metadata) will be removed from storage.