Shortimize API
Shortimize API provides endpoints for managing and tracking social media accounts and videos.
https://api.shortimize.comAuthentication
Get All Accounts
Premium Operation - contact support to gain access
Retrieves all accounts linked to your organisation in Shortimize. This endpoint provides a comprehensive list of all tracked social media accounts, including key metrics and performance indicators.
Use this to get an overview of all accounts under your organization's management.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
collections
Optional comma-separated list of collections to filter accounts (e.g. collection1,collection2,collection3)
Make sure to URL encode them before sending.
1
Stop Tracking Account
Stop tracking an account linked to your organisation.
Use this to pause tracking when you want to stop monitoring an account's performance or remove it from your active tracking portfolio. This is useful for accounts that are no longer relevant to your campaign or when you need to manage your tracking quota.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
id
The ID of the account that you want to stop tracking
1
{
"id": "ad occaecat"
}Track Account
Track an account and link it to your organisation in Shortimize.
A direct URL to the account on Shortimize will be returned.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
content-type
should be set to application/json
Possible Enum Values
application/json
Request Body
link
The URL of the account to start tracked
collection_ids
Optional list of collection UUIDs to associate with the account
collection_names
Optional list of collection names to create and associate with the account
tracking_type
Optional tracking type to use (e.g., 'latest_30', 'latest_200'). If left empty, will use the organisation default.
1
{
"link": "http://hxtSGIsZDCVt.cpmfRvUxgW3e6BK8ujr1nRHxJX56kHk3w9ayOm54diZLnXOURZ",
"collection_ids": [],
"collection_names": [],
"tracking_type": "aliquip"
}Get All Videos
Premium Operation - contact support to gain access
Retrieves a list of all videos tracked by your organization in Shortimize. This endpoint provides detailed information about each video, including engagement metrics, content details, and historical performance data.
Use this to get a comprehensive view of your video advertisement portfolio and their performance across different platforms.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
page
Page number for pagination
limit
Number of items to return per page
order_by
Field to order results by
Possible Enum Values
created_at
uploaded_at
latest_views
latest_likes
latest_comments
latest_bookmarks
latest_shares
order_direction
Direction of ordering (ascending or descending)
Possible Enum Values
asc
desc
username
Filter videos by specific username
linked_account_id
Filter videos by specific linked account ID
uploaded_at_start
Filter videos uploaded on or after this date (inclusive)
uploaded_at_end
Filter videos uploaded on or before this date (inclusive)
latest_updated_at_start
Filter videos which have been last updated on or after this date and time (inclusive)
latest_updated_at_end
Filter videos which have been last updated on or before this date and time (inclusive)
ad_info_shop
Filter TikTok shop ads (true/false)
ad_product_id_shop
Filter TikTok shop ads that have a product id. (true)
has_metrics
Only get videos which have been retrieved atleast once (metrics are not null).
collections
Optional comma-separated list of collections to filter accounts (e.g. collection1,collection2,collection3)
Make sure to URL encode them before sending.
1
Stop Tracking Video
Stops tracking specific videos in Shortimize. This operation allows you to selectively pause data collection for individual videos while maintaining their historical performance data and metrics. Use this when you need to stop monitoring particular videos that are no longer relevant to your campaign or to optimize your tracking quota. The videos' past performance data remains accessible for analysis and reporting purposes.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Request Body
id
The ID of the video that you want to stop tracking
1
{
"id": "http://KYKoThpGZuzliCZf.xzGWjgS6kn0wViNajj2jKWuU8mPldG7Nl7S9"
}Track Video
Track a video and link it to your organisation in Shortimize. A direct URL to the video analysis on Shortimize will be returned.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
content-type
Must be set to application/json
Possible Enum Values
application/json
Request Body
link
The URL of the video to be tracked
collection_ids
Optional list of collection UUIDs to associate with the video
collection_names
Optional list of collection names to create and associate with the video
1
{
"link": "in ad in Lorem veniam"
}Get Specific Video
Premium Operation - contact support to gain access
Retrieves detailed information about a specific video advertisement linked to your organisation in Shortimize via its ad_id. This endpoint provides comprehensive data including video metrics, performance indicators, and historical data. Use this to get in-depth insights into a particular video's performance, engagement rates, and audience reception.
The data includes:
- Video identification and platform details
- Latest engagement metrics (views, likes, comments, shares)
- Performance statistics (median views, outlier multiplier)
- Historical data for multiple data points
- Growth metrics (1-day and 7-day view increases)
This endpoint is crucial for analyzing the success of individual video advertisements and understanding their performance in the context of the account's overall metrics.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Get Video History
Premium Operation – Retrieves daily aggregated metrics for a specific video (ad_id) tracked by your organization. By default if no dates are passed, gets the last 30 days of data.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Query Parameters
start_date
Start date (inclusive) in YYYY-MM-DD format
end_date
End date (inclusive) in YYYY-MM-DD format
Path Parameters
ad_id
UUID of the video (ad)
1
Get Specific Account
Premium Operation - contact support to gain access
Retrieves detailed information about a specific account linked to your organisation in Shortimize via its account_id. This endpoint provides comprehensive data including account metrics, performance indicators, and historical data.
Use this to get in-depth insights into a particular account's performance and engagement.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Path Parameters
account_id
Unique identifier of the account
1
Get All Videos Linked To Account
Premium Operation - contact support to gain access
Retrieves a list of all videos tracked by your organization in Shortimize linked to a specific account. This endpoint provides detailed information about each video, including engagement metrics, content details, and historical performance data.
Use this to get a comprehensive view of your video advertisement portfolio and their performance across different platforms.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Total Videos
Retrieves the total count of videos being tracked by your organization in Shortimize.
This endpoint provides a quick snapshot of your video monitoring volume across all tracked accounts and platforms. Use this to monitor your video tracking usage, manage quotas, and understand the scale of your video performance tracking operations.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Total Accounts
Retrieves the total number of accounts currently being tracked by your organization in Shortimize.
This provides a quick overview of your account monitoring scope and helps manage your tracking capacity. Use this to track your account monitoring usage, plan capacity, and make informed decisions about account tracking allocation across your campaigns.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1
Shortimize MCP Server
MCP Server to be used with all the routes available.
Headers
Authorization
The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
1