Shortimize API

Account Management

Endpoint:https://api.shortimize.com

Manage and track social media accounts

Get All Accounts

GET
https://api.shortimize.com
/accounts

Premium Operation - upgrade to Premium API in the app.

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.

Rate Limit: 30 requests per minute

Get All Accounts › query Parameters

  • collectionsstring

    Optional comma-separated list of collections to filter accounts (e.g. collection1,collection2,collection3)

    Make sure to URL encode them before sending.

Get All Accounts › Headers

  • Authorizationstring · required

    Bearer token for authentication

Get All Accounts › Responses

Successful response with a list of accounts and their detailed information

  • organisation_idstring · uuid

    Unique identifier for your organization

  • account_idstring · uuid

    Unique identifier for the account

  • account_linkstring · uri

    URL of the social media account

  • usernamestring

    Username of the account

  • platformstring · enum

    Social media platform of the account

    Enum values:
    instagram
    tiktok
    youtube
  • created_atstring · date-time

    Timestamp when the account was added to Shortimize

  • checked_atstring · date-time

    Timestamp of the last data update

  • removedboolean

    Indicates if the account has been removed from tracking

  • privateboolean

    Indicates if the account is private

  • emptyboolean

    Indicates if the account has no content

  • biostring

    The bio of the account from the respective platform

  • linkstring

    The primary link of the account from the respective platform

  • latest_followers_countinteger | null

    Most recent follower count, null if not available

  • latest_following_countinteger | null

    Most recent following count, null if not available

  • tracking_typestring

    Type of tracking applied to this account

  • mean_viewsnumber

    Average number of views across tracked videos

  • most_viewedinteger

    Highest number of views for a single video

  • median_viewsnumber

    Median number of views across tracked videos

  • median_views_non_zeronumber

    Median number of views across tracked videos (videos with greater than 0 views)

  • median_likesnumber

    Median number of likes across tracked videos

  • percent_outperform_10xnumber

    Percentage of videos outperforming by 10x

  • percent_outperform_25xnumber

    Percentage of videos outperforming by 25x

  • last_uploaded_atstring · date

    Date of the last uploaded video

  • total_videos_trackedinteger

    Total number of videos being tracked

  • total_viewsinteger

    Total views across all tracked videos

  • total_likesinteger

    Total likes across all tracked videos

  • total_commentsinteger

    Total comments across all tracked videos

  • total_bookmarksinteger

    Total bookmarks across all tracked videos

  • total_sharesinteger

    Total shares across all tracked videos

  • total_engagementinteger

    Total engagement across all tracked videos (likes + comments + shares + bookmarks)

  • label_idsarray | null

    Array of collection/label IDs associated with the account

  • label_namesarray | null

    Array of collection/label names associated with the account

  • history_arrayobject[]

    Historical data array, typically containing the last 30 days of data - will be deprecated soon into it's own endpoint.

Track Account

POST
https://api.shortimize.com
/accounts

Track an account and link it to your organisation in Shortimize.

A direct URL to the account on Shortimize will be returned.

Rate Limit: 120 requests per minute

Track Account › Headers

  • Authorizationstring · required

    Bearer token for authentication

  • content-typestring · enum · required

    should be set to application/json

    Enum values:
    application/json

Track Account › Request Body

  • linkstring · uri · required

    The URL of the account to start tracked

  • collection_idsstring[]

    Optional list of collection UUIDs to associate with the account

  • collection_namesstring[]

    Optional list of collection names to create and associate with the account

  • tracking_typestring

    Optional tracking type to use (e.g., 'latest_30', 'latest_200'). If left empty, will use the organisation default.

Track Account › Responses

Successful operation

  • properties

Stop Tracking Account

DELETE
https://api.shortimize.com
/accounts

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.

Rate Limit: 120 requests per minute

Stop Tracking Account › Headers

  • Authorizationstring · required

    Bearer token for authentication

Stop Tracking Account › Request Body

  • idstring · required

    The ID of the account that you want to stop tracking

Stop Tracking Account › Responses

Rate Limiting Response

  • typestring · required

    A URI reference that identifies the problem.

  • titlestring · required

    A short, human-readable summary of the problem.

  • statusnumber · required

    The HTTP status code.

  • instancestring

Bulk Track Accounts

POST
https://api.shortimize.com
/accounts/bulk

Track multiple accounts and link them to your organisation in Shortimize in a single request.

Each account will be processed individually, and a summary of results will be returned. Maximum 100 accounts per request.

Rate Limit: 120 requests per minute

Bulk Track Accounts › Headers

  • Authorizationstring · required

    Bearer token for authentication

  • content-typestring · enum · required

    should be set to application/json

    Enum values:
    application/json

Bulk Track Accounts › Request Body

  • linksstring[] · minItems: 1 · maxItems: 100 · required

    Array of account URLs to track

  • label_idsstring[]

    Optional label IDs to apply to all tracked accounts

  • tracking_typestring · enum

    Optional tracking type. Defaults to organisation setting.

    Enum values:
    latest_10
    latest_30
    latest_60
    latest_100
    latest_200
    latest_500
    all_videos

Bulk Track Accounts › Responses

All accounts tracked successfully

  • successboolean
  • summaryobject
  • resultsobject[]

Bulk Stop Tracking Accounts

DELETE
https://api.shortimize.com
/accounts/bulk

Stop tracking multiple accounts linked to your organisation in a single request.

Use this to efficiently remove multiple accounts from your active tracking portfolio. Historical data for these accounts remains accessible.

Rate Limit: 120 requests per minute

Bulk Stop Tracking Accounts › Headers

  • Authorizationstring · required

    Bearer token for authentication

Bulk Stop Tracking Accounts › Request Body

  • idsstring[] · minItems: 1 · maxItems: 100 · required

    Array of account IDs to stop tracking

  • leave_videosboolean

    If true, videos linked to these accounts will not be removed

    Default: false

Bulk Stop Tracking Accounts › Responses

All accounts successfully stopped tracking

  • successboolean
  • summaryobject
  • resultsobject[]

Get Account History

GET
https://api.shortimize.com
/accounts/{account_id}/history

Premium Operation - upgrade to Premium API in the app.

Retrieves daily aggregated metrics for a specific account (account_id) tracked by your organization. By default if no dates are passed, gets the last 90 days of data. Maximum date range is limited to 90 days in the past.

Rate Limit: 120 requests per minute

Get Account History › path Parameters

  • account_idstring · required

    Account identifier - can be a UUID or account URL (URL-encoded)

Get Account History › query Parameters

  • start_datestring · date

    Start date (inclusive) in YYYY-MM-DD format

  • end_datestring · date

    End date (inclusive) in YYYY-MM-DD format

Get Account History › Headers

  • Authorizationstring · required

    Bearer token for authentication

Get Account History › Responses

List of daily metrics for the specified account

  • datestring · date
  • viewsinteger

    Total views for the day

  • likesinteger

    Total likes for the day

  • commentsinteger

    Total comments for the day

  • sharesinteger

    Total shares for the day

  • bookmarksinteger

    Total bookmarks for the day

  • engagementsinteger

    Total engagements for the day (likes + comments + shares + bookmarks)

  • ads_upload_countinteger

    Number of videos uploaded on this day

  • total_adsinteger

    Total number of videos tracked for this account on this day

Get Specific Account

GET
https://api.shortimize.com
/accounts/{account_id}

Premium Operation - upgrade to Premium API in the app.

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.

Rate Limit: 30 requests per minute

Get Specific Account › path Parameters

  • account_idstring · required

    Account identifier - can be a UUID or account URL (URL-encoded)

Get Specific Account › Headers

  • Authorizationstring · required

    Bearer token for authentication

Get Specific Account › Responses

Successful response with detailed information about the specific account

  • organisation_idstring · uuid

    Unique identifier for your organization

  • account_idstring · uuid

    Unique identifier for the account

  • account_linkstring · uri

    URL of the social media account

  • usernamestring

    Username of the account

  • platformstring · enum

    Social media platform of the account

    Enum values:
    instagram
    tiktok
    youtube
  • created_atstring · date-time

    Timestamp when the account was added to Shortimize

  • checked_atstring · date-time

    Timestamp of the last data update

  • removedboolean

    Indicates if the account has been removed from tracking

  • privateboolean

    Indicates if the account is private

  • emptyboolean

    Indicates if the account has no content

  • biostring

    The bio of the account from the respective platform

  • linkstring

    The primary link of the account from the respective platform

  • latest_followers_countinteger | null

    Most recent follower count, null if not available

  • latest_following_countinteger | null

    Most recent following count, null if not available

  • tracking_typestring

    Type of tracking applied to this account

  • mean_viewsnumber

    Average number of views across tracked videos

  • most_viewedinteger

    Highest number of views for a single video

  • median_viewsnumber

    Median number of views across tracked videos

  • median_views_non_zeronumber

    Median number of views across tracked videos (videos with greater than 0 views)

  • median_likesnumber

    Median number of likes across tracked videos

  • percent_outperform_10xnumber

    Percentage of videos outperforming by 10x

  • percent_outperform_25xnumber

    Percentage of videos outperforming by 25x

  • last_uploaded_atstring · date

    Date of the last uploaded video

  • total_videos_trackedinteger

    Total number of videos being tracked

  • total_viewsinteger

    Total views across all tracked videos

  • total_likesinteger

    Total likes across all tracked videos

  • total_commentsinteger

    Total comments across all tracked videos

  • total_bookmarksinteger

    Total bookmarks across all tracked videos

  • total_sharesinteger

    Total shares across all tracked videos

  • total_engagementinteger

    Total engagement across all tracked videos (likes + comments + shares + bookmarks)

  • label_idsarray | null

    Array of collection/label IDs associated with the account

  • label_namesarray | null

    Array of collection/label names associated with the account

Video Management