Skip to main content
Short Io logo
  • Category: url shortener
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 41
  • Triggers: 0
  • Slug: SHORT_IO
  • Version: 20261101_00

Tools

Slug: SHORT_IO_CREATE_FOLDERTool to create a new folder for organizing links within a domain. Use when you need to organize links into categories or groups.

Input Parameters

string
required
The name of the folder to create.
integer
required
The domain ID to create the folder under. Obtain from Domain Settings in Short.io Dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_GET_BUNDLE_TEMPLATESTool to retrieve all available bundle templates. Use when you need to list or select from predefined bundle templates for creating link bundles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_GET_DOMAIN_BY_IDTool to retrieve detailed information for a specific domain by its ID. Use when you need to fetch configuration details, settings, or metadata for a domain.

Input Parameters

integer
required
Unique identifier of the domain to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_GET_DOMAINS_PATHSTool to list the most popular paths in a domain over time. Use after confirming a valid domain ID to analyze which short URL paths under that domain have received the most clicks in the given interval.

Input Parameters

string
Timezone name for date boundaries (e.g., ‘UTC’, ‘America/New_York’).
string ("custom" | "today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30")
Time interval for which to retrieve the most popular paths. Use ‘custom’ to supply startDate and endDate.
string
End date (YYYY-MM-DD) for custom period; required when period=‘custom’. Automatically converted to milliseconds from epoch.
integer
required
Identifier of the domain whose path statistics will be retrieved.
string
Start date (YYYY-MM-DD) for custom period; required when period=‘custom’. Automatically converted to milliseconds from epoch.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_GET_DOMAIN_STATISTICSTool to get comprehensive statistics for a domain over a specified period. Returns click metrics, link counts, and analytics breakdowns by referrer, social media, browser, country, city, and OS. Use when you need domain-level analytics.

Input Parameters

string ("today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30" | "custom")
Statistics period. Use ‘custom’ for custom date range with startDate and endDate.
integer
End date timestamp in milliseconds (required when period is ‘custom’).
string
required
The domain ID to get statistics for.
string
Timezone offset for statistics calculation (e.g., ‘0’ for UTC).
integer
Start date timestamp in milliseconds (required when period is ‘custom’).
string ("hour" | "day" | "week" | "month")
Granularity for click statistics chart; one of hour, day, week, month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_GET_FOLDERTool to retrieve folder details by ID. Use when you need to get information about a specific folder within a domain.

Input Parameters

string
required
The domain ID that the folder belongs to.
string
required
The unique folder ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_LIST_DOMAINSTool to retrieve all domains associated with the Short.io account. Use when you need to list available domains for creating short links or managing domain settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_LIST_FOLDERSList folders for a specific Short.io domain, including their names and IDs. Use the results to identify folders when organizing or filtering links.

Input Parameters

integer
required
REQUIRED. Domain ID to list folders from. Obtain from Domain Settings in Short.io Dashboard.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_POST_DOMAIN_LINK_CLICKSTool to get click statistics for specific links in a domain using POST method. Use when you need click counts for multiple link paths with their creation dates. This POST version allows batch retrieval of link click statistics by providing an array of paths and their creation timestamps.

Input Parameters

string
Returns statistics for clicks before given date (format: YYYY-MM-DD).
integer
required
Numeric identifier of the domain to retrieve link click statistics for.
string
Returns statistics for clicks after given date (format: YYYY-MM-DD).
array
required
List of link paths with their creation dates to get click counts for.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_POST_DOMAINS_BY_INTERVALTool to retrieve domain statistics over a custom interval. Use when you need time-series click data for a specific domain over a defined time window.

Input Parameters

string
IANA timezone name for interval boundaries; defaults to ‘UTC’.
string ("custom" | "today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30")
Time interval for statistics. Defaults to ‘last30’. Use ‘custom’ to specify a start and end date.
string
End date (YYYY-MM-DD) for custom interval; required if period is ‘custom’.
integer
required
Identifier of the domain to fetch statistics for.
string
Start date (YYYY-MM-DD) for custom interval; required if period is ‘custom’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_POST_DOMAINS_LAST_CLICKSTool to retrieve the latest raw click events for a domain. Use when detailed clickstream data is needed.

Input Parameters

string
IANA timezone for grouping; defaults to UTC.
integer
Maximum number of click events to retrieve; defaults to 30.
string ("custom" | "today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30")
Preset time interval; use ‘custom’ with startDate and endDate.
string
End date for ‘custom’ period (YYYY-MM-DD).
object
Filters to exclude specific click events.
object
Filters to include specific click events.
integer
required
Identifier of the domain to fetch click events for.
string
Pagination: return events after this date.
string
Start date for ‘custom’ period (YYYY-MM-DD).
string
Pagination: return events before this date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_POST_DOMAIN_STATSTool to get detailed statistics for a domain over a specified period. Use when you need comprehensive domain metrics including clicks, links, referrers, geographic data, and browser/OS breakdowns.

Input Parameters

string
IANA timezone name for interval boundaries; defaults to UTC.
string ("custom" | "today" | "yesterday" | "total" | "week" | "month" | "lastmonth" | "last7" | "last30")
Time interval for statistics. Use ‘custom’ to specify custom dates.
string
End date (YYYY-MM-DD) for custom interval; required if period is ‘custom’.
object
Filter structure for including or excluding specific click records.
object
Filter structure for including or excluding specific click records.
integer
required
Identifier of the domain to fetch statistics for.
boolean
Whether to skip top referrer/browser/country records.
string
Start date (YYYY-MM-DD) for custom interval; required if period is ‘custom’.
string ("hour" | "day" | "week" | "month")
Granularity for click statistics chart.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_POST_DOMAINS_TOPRetrieves top values for a specified analytics column ranked by click count for a domain. Use to analyze which paths, countries, or other dimensions have the most traffic. Returns an ordered list of values with their click counts.

Input Parameters

integer
Maximum number of top values to return; must be at least 1.
string ("path" | "path_404" | "method" | "st" | "proto" | "human" | "browser" | "browser_version" | "country" | "city" | "social" | "refhost" | "os" | "utm_source" | "utm_medium" | "utm_campaign" | "goal_completed" | "ab_path")
required
Provider-supported analytics column to rank by click count.
integer
required
Identifier of the domain for which to retrieve top column values.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_POST_LINKS_QR_BULKGenerate QR codes for multiple short links in bulk and return the images as a binary ZIP payload.

Input Parameters

integer
Size of the QR code (1-99).
string ("png" | "svg")
Image format for QR codes. Defaults to ‘png’.
string
Foreground color for QR code (hex code without # prefix, e.g., ‘000000’ or ‘FF0000’).
List of up to 150 link IDs to generate QR codes for.
string
Optional domain ID to override default domain settings.
boolean
If true, disables the ‘eye’ excavation in the QR code.
string
Background color for QR code (hex code without # prefix, e.g., ‘FFFFFF’ or ‘F0F0F0’).
boolean
Whether to apply domain-level QR settings. Defaults to true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SHORT_IO_UPDATE_DOMAIN_SETTINGSUpdate the root redirect URL for a Short.io domain by its ID.

Input Parameters

string
required
The unique identifier of the domain to update.
string
URL to redirect customers when visiting your short domain root. If not provided, the existing redirect URL remains unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not