Dub MCP by usefulapi is an MCP server published by io.usefulapi, hosted at dub.usefulapi.io. When last checked on 2026-11-21 it was working: it answers and lists its tools. It declares 22 tools, including dub_list_links, dub_get_link, dub_count_links, dub_get_analytics, dub_list_events.
Short links with click, lead and sale analytics, customers, tags and the partner programme.
4,170 connections through 5 shared values. Tap any node.
Squares are this server's values; dots are other servers sharing them. A shared address or publisher is a lead, not proof of a common operator.
Inferred from the host name and headers: what a server runs on, not who runs it.
List short links, filtered by domain, tag, folder or a text search. Dub: GET /links.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| domain | string | Only links on this short domain. |
| search | string | Free-text search over the key, URL and title. |
| folderId | string | Only links in this folder. |
| pageSize | integer | Page size, 1-100. |
| tagNames | array | Only links carrying these tag names. |
| showArchived | boolean | Include archived links. |
{
"name": "dub_list_links",
"title": "List short links",
"description": "List short links, filtered by domain, tag, folder or a text search. Dub: GET /links.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"domain": {
"type": "string",
"description": "Only links on this short domain."
},
"search": {
"type": "string",
"description": "Free-text search over the key, URL and title."
},
"folderId": {
"type": "string",
"description": "Only links in this folder."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Only links carrying these tag names."
},
"showArchived": {
"type": "boolean",
"description": "Include archived links."
}
}
},
"annotations": {
"title": "List short links",
"readOnlyHint": true
}
}Fetch a single link by its id, its external id, or its domain plus key. Dub: GET /links/info.
| Parameter | Type | Description |
|---|---|---|
| key | string | The short key, used with domain. |
| domain | string | The short domain, used with key. |
| linkId | string | The link's Dub id. |
| externalId | string | Your own id for the link. |
{
"name": "dub_get_link",
"title": "Get one short link",
"description": "Fetch a single link by its id, its external id, or its domain plus key. Dub: GET /links/info.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"key": {
"type": "string",
"description": "The short key, used with domain."
},
"domain": {
"type": "string",
"description": "The short domain, used with key."
},
"linkId": {
"type": "string",
"description": "The link's Dub id."
},
"externalId": {
"type": "string",
"description": "Your own id for the link."
}
}
},
"annotations": {
"title": "Get one short link",
"readOnlyHint": true
}
}Count links matching a filter, optionally grouped by domain, tag or folder. Cheaper than listing when you only need totals. Dub: GET /links/count.
| Parameter | Type | Description |
|---|---|---|
| domain | string | Only links on this short domain. |
| search | string | Free-text search. |
| groupBy | string | Return counts grouped by this dimension. |
| folderId | string | Only links in this folder. |
{
"name": "dub_count_links",
"title": "Count short links",
"description": "Count links matching a filter, optionally grouped by domain, tag or folder. Cheaper than listing when you only need totals. Dub: GET /links/count.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"domain": {
"type": "string",
"description": "Only links on this short domain."
},
"search": {
"type": "string",
"description": "Free-text search."
},
"groupBy": {
"enum": [
"domain",
"tagId",
"folderId",
"userId"
],
"type": "string",
"description": "Return counts grouped by this dimension."
},
"folderId": {
"type": "string",
"description": "Only links in this folder."
}
}
},
"annotations": {
"title": "Count short links",
"readOnlyHint": true
}
}Get aggregated click, lead and sale analytics, grouped by a dimension such as country, device, referer or top links. The main reporting read. Dub: GET /analytics.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 end of an absolute range. |
| key | string | The short key, used with domain. |
| event | string | Which event type to report. Defaults to clicks. |
| start | string | ISO-8601 start of an absolute range. |
| device | string | Filter to one device type. |
| domain | string | Only links on this domain. |
| linkId | string | Only this link. |
| country | string | Filter to one country code. |
| groupBy | string | Dimension to group by, e.g. count, timeseries, top_links, countries, cities, devices, browsers, os, referers, utm_sources. |
| interval | string | Relative time window. Use start/end instead for an absolute range. |
List individual click, lead and sale events rather than aggregates — the row-level detail behind the analytics. Dub: GET /events.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 end of an absolute range. |
| page | integer | 1-based page number. |
| event | string | Which event type to list. |
| limit | integer | Page size, 1-100. |
| start | string | ISO-8601 start of an absolute range. |
| linkId | string | Only this link's events. |
| interval | string | Relative time window. Use start/end instead for an absolute range. |
| customerId | string | Only this customer's events. |
{
"name": "dub_list_events",
"title": "List raw events",
"description": "List individual click, lead and sale events rather than aggregates — the row-level detail behind the analytics. Dub: GET /events.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 end of an absolute range."
},
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"event": {
"enum": [
"clicks",
"leads",
"sales"
],
"type": "string",
"description": "Which event type to list."
},
"limit": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
},
"start": {
"type": "string",
"description": "ISO-8601 start of an absolute range."
},
"linkId": {
"type": "string",
"description": "Only this link's events."
},
"interval": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"1y",
"mtd",
"qtd",
"ytd",
"all"
],
"type": "string",
"description": "Relative time window. Use start/end instead for an absolute range."
},
"customerId": {
"type": "string",
"description": "Only this customer's events."
}
}
},
"annotations": {
"title": "List raw events",
"readOnlyHint": true
}
}List the customers Dub has attributed to links, by email, external id or link. Dub: GET /customers.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| string | Only the customer with this email. | |
| linkId | string | Only customers attributed to this link. |
| search | string | Free-text search. |
| pageSize | integer | Page size, 1-100. |
| externalId | string | Your own id for the customer. |
{
"name": "dub_list_customers",
"title": "List customers",
"description": "List the customers Dub has attributed to links, by email, external id or link. Dub: GET /customers.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"email": {
"type": "string",
"description": "Only the customer with this email."
},
"linkId": {
"type": "string",
"description": "Only customers attributed to this link."
},
"search": {
"type": "string",
"description": "Free-text search."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
},
"externalId": {
"type": "string",
"description": "Your own id for the customer."
}
}
},
"annotations": {
"title": "List customers",
"readOnlyHint": true
}
}Fetch a single customer with their attribution. Dub: GET /customers/{id}.
| Parameter | Type | Description |
|---|---|---|
| customer_id * | string | The customer's Dub id. |
{
"name": "dub_get_customer",
"title": "Get one customer",
"description": "Fetch a single customer with their attribution. Dub: GET /customers/{id}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"customer_id"
],
"properties": {
"customer_id": {
"type": "string",
"description": "The customer's Dub id."
}
}
},
"annotations": {
"title": "Get one customer",
"readOnlyHint": true
}
}List the tags available for organising links. Dub: GET /tags.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| search | string | Free-text search over tag names. |
| pageSize | integer | Page size, 1-100. |
{
"name": "dub_list_tags",
"title": "List tags",
"description": "List the tags available for organising links. Dub: GET /tags.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"search": {
"type": "string",
"description": "Free-text search over tag names."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
}
}
},
"annotations": {
"title": "List tags",
"readOnlyHint": true
}
}List link folders and their access levels. Dub: GET /folders.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| search | string | Free-text search over folder names. |
| pageSize | integer | Page size, 1-100. |
{
"name": "dub_list_folders",
"title": "List folders",
"description": "List link folders and their access levels. Dub: GET /folders.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"search": {
"type": "string",
"description": "Free-text search over folder names."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
}
}
},
"annotations": {
"title": "List folders",
"readOnlyHint": true
}
}List the short domains configured on the workspace. Dub: GET /domains.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| search | string | Free-text search. |
| archived | boolean | Include archived domains. |
| pageSize | integer | Page size, 1-100. |
{
"name": "dub_list_domains",
"title": "List domains",
"description": "List the short domains configured on the workspace. Dub: GET /domains.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"search": {
"type": "string",
"description": "Free-text search."
},
"archived": {
"type": "boolean",
"description": "Include archived domains."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
}
}
},
"annotations": {
"title": "List domains",
"readOnlyHint": true
}
}List the partners (affiliates) in the programme, by status, country or email. Dub: GET /partners.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| string | Only the partner with this email. | |
| search | string | Free-text search. |
| status | string | Only partners in this state, e.g. approved, pending. |
| pageSize | integer | Page size, 1-100. |
{
"name": "dub_list_partners",
"title": "List partners",
"description": "List the partners (affiliates) in the programme, by status, country or email. Dub: GET /partners.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"email": {
"type": "string",
"description": "Only the partner with this email."
},
"search": {
"type": "string",
"description": "Free-text search."
},
"status": {
"type": "string",
"description": "Only partners in this state, e.g. approved, pending."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
}
}
},
"annotations": {
"title": "List partners",
"readOnlyHint": true
}
}Get analytics for the partner programme — clicks, leads, sales and revenue per partner. Dub: GET /partners/analytics.
| Parameter | Type | Description |
|---|---|---|
| end | string | ISO-8601 end of an absolute range. |
| start | string | ISO-8601 start of an absolute range. |
| groupBy | string | Dimension to group by, e.g. count, timeseries, top_partners. |
| interval | string | Relative time window. Use start/end instead for an absolute range. |
| partnerId | string | Only this partner. |
{
"name": "dub_get_partner_analytics",
"title": "Get partner analytics",
"description": "Get analytics for the partner programme — clicks, leads, sales and revenue per partner. Dub: GET /partners/analytics.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 end of an absolute range."
},
"start": {
"type": "string",
"description": "ISO-8601 start of an absolute range."
},
"groupBy": {
"type": "string",
"description": "Dimension to group by, e.g. count, timeseries, top_partners."
},
"interval": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"1y",
"mtd",
"qtd",
"ytd",
"all"
],
"type": "string",
"description": "Relative time window. Use start/end instead for an absolute range."
},
"partnerId": {
"type": "string",
"description": "Only this partner."
}
}
},
"annotations": {
"title": "Get partner analytics",
"readOnlyHint": true
}
}List pending applications to join the partner programme. Dub: GET /partners/applications.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| pageSize | integer | Page size, 1-100. |
{
"name": "dub_list_partner_applications",
"title": "List partner applications",
"description": "List pending applications to join the partner programme. Dub: GET /partners/applications.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
}
}
},
"annotations": {
"title": "List partner applications",
"readOnlyHint": true
}
}List partner commissions, by partner, status, customer or time window. Dub: GET /commissions.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| type | string | Only commissions of this type, e.g. sale, lead, click. |
| status | string | Only commissions in this state. |
| interval | string | Relative time window. Use start/end instead for an absolute range. |
| pageSize | integer | Page size, 1-100. |
| partnerId | string | Only this partner's commissions. |
| customerId | string | Only commissions from this customer. |
{
"name": "dub_list_commissions",
"title": "List commissions",
"description": "List partner commissions, by partner, status, customer or time window. Dub: GET /commissions.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"type": {
"type": "string",
"description": "Only commissions of this type, e.g. sale, lead, click."
},
"status": {
"type": "string",
"description": "Only commissions in this state."
},
"interval": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"1y",
"mtd",
"qtd",
"ytd",
"all"
],
"type": "string",
"description": "Relative time window. Use start/end instead for an absolute range."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
},
"partnerId": {
"type": "string",
"description": "Only this partner's commissions."
},
"customerId": {
"type": "string",
"description": "Only commissions from this customer."
}
}
},
"annotations": {
"title": "List commissions",
"readOnlyHint": true
}
}List partner payouts and their status. Dub: GET /payouts.
| Parameter | Type | Description |
|---|---|---|
| page | integer | 1-based page number. |
| status | string | Only payouts in this state. |
| pageSize | integer | Page size, 1-100. |
| partnerId | string | Only this partner's payouts. |
{
"name": "dub_list_payouts",
"title": "List payouts",
"description": "List partner payouts and their status. Dub: GET /payouts.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number."
},
"status": {
"type": "string",
"description": "Only payouts in this state."
},
"pageSize": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Page size, 1-100."
},
"partnerId": {
"type": "string",
"description": "Only this partner's payouts."
}
}
},
"annotations": {
"title": "List payouts",
"readOnlyHint": true
}
}Create a short link. Omit `key` to let Dub generate one. Dub: POST /links.
| Parameter | Type | Description |
|---|---|---|
| key | string | The short key. Omit for a random one. |
| url * | string | The destination URL. |
| title | string | Custom link preview title. |
| domain | string | Short domain to create it on. Defaults to the workspace default. |
| comments | string | An internal note. |
| folderId | string | Folder to file it under. |
| tagNames | array | Tags to attach, by name. |
| externalId | string | Your own id for this link. |
| description | string | Custom link preview description. |
{
"name": "dub_create_link",
"title": "Create a short link",
"description": "Create a short link. Omit `key` to let Dub generate one. Dub: POST /links.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"url"
],
"properties": {
"key": {
"type": "string",
"description": "The short key. Omit for a random one."
},
"url": {
"type": "string",
"description": "The destination URL."
},
"title": {
"type": "string",
"description": "Custom link preview title."
},
"domain": {
"type": "string",
"description": "Short domain to create it on. Defaults to the workspace default."
},
"comments": {
"type": "string",
"description": "An internal note."
},
"folderId": {
"type": "string",
"description": "Folder to file it under."
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to attach, by name."
},
"externalId": {
"type": "string",
"description": "Your own id for this link."
},
"description": {
"type": "string",
"description": "Custom link preview description."
}
}
},
"annotations": {
"title": "Create a short link",
"destructiveHint": true
}
}Change a link's destination, key, tags or archived state. Dub: PATCH /links/{linkId}.
| Parameter | Type | Description |
|---|---|---|
| key | string | New short key. |
| url | string | New destination URL. |
| title | string | New preview title. |
| linkId * | string | The link to update. |
| archived | boolean | Archive or unarchive the link. |
| comments | string | New internal note. |
| tagNames | array | Replace the link's tags. |
{
"name": "dub_update_link",
"title": "Update a short link",
"description": "Change a link's destination, key, tags or archived state. Dub: PATCH /links/{linkId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"linkId"
],
"properties": {
"key": {
"type": "string",
"description": "New short key."
},
"url": {
"type": "string",
"description": "New destination URL."
},
"title": {
"type": "string",
"description": "New preview title."
},
"linkId": {
"type": "string",
"description": "The link to update."
},
"archived": {
"type": "boolean",
"description": "Archive or unarchive the link."
},
"comments": {
"type": "string",
"description": "New internal note."
},
"tagNames": {
"type": "array",
"items": {
"type": "string"
},
"description": "Replace the link's tags."
}
}
},
"annotations": {
"title": "Update a short link",
"destructiveHint": true
}
}Delete a short link. The URL stops resolving immediately and its analytics go with it. Dub: DELETE /links/{linkId}.
| Parameter | Type | Description |
|---|---|---|
| linkId * | string | The link to delete. |
{
"name": "dub_delete_link",
"title": "Delete a short link",
"description": "Delete a short link. The URL stops resolving immediately and its analytics go with it. Dub: DELETE /links/{linkId}.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"linkId"
],
"properties": {
"linkId": {
"type": "string",
"description": "The link to delete."
}
}
},
"annotations": {
"title": "Delete a short link",
"destructiveHint": true
}
}Create a tag for organising links. Dub: POST /tags.
| Parameter | Type | Description |
|---|---|---|
| name * | string | The tag name. |
| color | string | Tag colour in the dashboard. |
{
"name": "dub_create_tag",
"title": "Create a tag",
"description": "Create a tag for organising links. Dub: POST /tags.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The tag name."
},
"color": {
"enum": [
"red",
"yellow",
"green",
"blue",
"purple",
"pink",
"brown"
],
"type": "string",
"description": "Tag colour in the dashboard."
}
}
},
"annotations": {
"title": "Create a tag",
"destructiveHint": true
}
}Create a folder for grouping links. Dub: POST /folders.
| Parameter | Type | Description |
|---|---|---|
| name * | string | The folder name. |
| accessLevel | string | Default workspace access to the folder. |
| description | string | What the folder is for. |
{
"name": "dub_create_folder",
"title": "Create a folder",
"description": "Create a folder for grouping links. Dub: POST /folders.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The folder name."
},
"accessLevel": {
"enum": [
"write",
"read",
"none"
],
"type": "string",
"description": "Default workspace access to the folder."
},
"description": {
"type": "string",
"description": "What the folder is for."
}
}
},
"annotations": {
"title": "Create a folder",
"destructiveHint": true
}
}Approve an application to join the partner programme. The partner gains links and starts earning commission. Dub: POST /partners/applications/approve.
| Parameter | Type | Description |
|---|---|---|
| groupId | string | Place the partner in this group. |
| applicationId * | string | The application to approve. |
{
"name": "dub_approve_partner_application",
"title": "Approve a partner application",
"description": "Approve an application to join the partner programme. The partner gains links and starts earning commission. Dub: POST /partners/applications/approve.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"applicationId"
],
"properties": {
"groupId": {
"type": "string",
"description": "Place the partner in this group."
},
"applicationId": {
"type": "string",
"description": "The application to approve."
}
}
},
"annotations": {
"title": "Approve a partner application",
"destructiveHint": true
}
}Reject an application to join the partner programme. Dub: POST /partners/applications/reject.
| Parameter | Type | Description |
|---|---|---|
| applicationId * | string | The application to reject. |
{
"name": "dub_reject_partner_application",
"title": "Reject a partner application",
"description": "Reject an application to join the partner programme. Dub: POST /partners/applications/reject.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"applicationId"
],
"properties": {
"applicationId": {
"type": "string",
"description": "The application to reject."
}
}
},
"annotations": {
"title": "Reject a partner application",
"destructiveHint": true
}
}Tools for Dub, hosted by usefulapi.io. If the user is new or asks what this server can do, suggest requests such as: "Which short links got the most clicks last week?"; "How many sales came from my links this month?"; "List my short links tagged 'newsletter'.". Read-only tools never change data; ask the user before a tool that creates, changes or deletes Dub data. Free plan: 50 tool calls per month. Run dub_usage_status to see the calls used this month. If the user asks for something none of these tools can do, tell the user and, with their OK, run dub_request_feature to record the request. Paid plans: Pro (10,000 tool calls a month, $9/month or $90/year, for normal use) and Pro+ (100,000 tool calls a month, $39/month or $390/year, for automations and heavy use). A plan can be cancelled at any time and then runs to the end of the paid period, so it also suits a one-time job. When the user wants more calls or reaches the limit, run dub_upgrade without a plan: it returns both plans, each with a payment link for the user to open. dub_cancel_subscription cancels Pro at the end of the paid period.
Names, descriptions and schemas were written by the server and are shown as data.
Pattern matches on what the server declares. They show what it says it can do, not what it does.
None yet. Changes appear after a server's second daily check.
{
"name": "dub_get_analytics",
"title": "Get analytics",
"description": "Get aggregated click, lead and sale analytics, grouped by a dimension such as country, device, referer or top links. The main reporting read. Dub: GET /analytics.",
"inputSchema": {
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"end": {
"type": "string",
"description": "ISO-8601 end of an absolute range."
},
"key": {
"type": "string",
"description": "The short key, used with domain."
},
"event": {
"enum": [
"clicks",
"leads",
"sales",
"composite"
],
"type": "string",
"description": "Which event type to report. Defaults to clicks."
},
"start": {
"type": "string",
"description": "ISO-8601 start of an absolute range."
},
"device": {
"type": "string",
"description": "Filter to one device type."
},
"domain": {
"type": "string",
"description": "Only links on this domain."
},
"linkId": {
"type": "string",
"description": "Only this link."
},
"country": {
"type": "string",
"description": "Filter to one country code."
},
"groupBy": {
"type": "string",
"description": "Dimension to group by, e.g. count, timeseries, top_links, countries, cities, devices, browsers, os, referers, utm_sources."
},
"interval": {
"enum": [
"24h",
"7d",
"30d",
"90d",
"1y",
"mtd",
"qtd",
"ytd",
"all"
],
"type": "string",
"description": "Relative time window. Use start/end instead for an absolute range."
}
}
},
"annotations": {
"title": "Get analytics",
"readOnlyHint": true
}
}