get_click_counters | Click counts grouped by one dimension: {total, values: [{count, value}]} (top 10 000 values; total covers every group). Statistics calls count against the plan usage allowance (Free plan: 50 per hour and 100 per month). Arguments: workspace_id (string, required, from list_workspaces); counter (string, required: country, city, region, platform, destination, referer, bot_name, isp, link_id, remote_ip, top_params, ad_network, utm_source, utm_medium, utm_campaign, utm_content or utm_term); link_id (string) or link_ids (array of integer link ids); start and end (“YYYY-MM-DD”); country (ISO alpha-2 string); bots (boolean, false = exclude bots); unique (boolean). Always JSON. |
get_clicks | Click time series of a workspace: {traffic: [{t, y}]}. Statistics calls count against the plan usage allowance (Free plan: 50 per hour and 100 per month): group the questions. Arguments: workspace_id (string, required, from list_workspaces); link_id (string, one link) or link_ids (array of integer link ids); start and end (“YYYY-MM-DD” or “YYYY-MM-DDTHH:MM:SSZ”); country (ISO alpha-2 string); browser, platform, referer, isp (strings); bots (boolean, false = exclude bots); unique (boolean, true = unique clicks only); timezone (string, e.g. “Europe/Paris”); frequency (“day” default or “hour”); pivot (“link_id” = one column per link). Always JSON. |
get_link | Get one link: destination, short URL, UTM parameters, rules and configuration (no click counts: use get_clicks or list_links). Arguments: id (string, required, the link id from list_links); workspace_id (string, optional, from list_workspaces). |
list_domains | List the custom domains of a workspace (usable as domain in save_link). Argument: workspace_id (string, required, from list_workspaces). |
list_links | List the links of a workspace: {links, page_number, page_size, total_entries, total_pages, total_rows, workspace_link_count}, each link with its id, short URL and click totals. Arguments: workspace_id (string, required, from list_workspaces); search (string); page (integer, default 1); page_size (integer, default 1000); sort_by (string: any link column, or clicks_total, clicks_today, clicks_previous_day, clicks_thirty_days, human_clicks_total, human_clicks_thirty_days, human_clicks_today, human_clicks_previous_day); sort_dir (“asc” or “desc”); filters, each an exact match, ANDed: domain, slug, utm_source, utm_medium, utm_campaign, utm_content, utm_term (strings). |
list_workspaces | List the workspaces the key can access: [{id, name}]. The workspace id is needed by list_links, get_clicks, get_click_counters, list_domains and save_link. Also used as the credential probe. No arguments. |