> ## Documentation Index
> Fetch the complete documentation index at: https://docs.dashlink.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Analytics

> Click and scan analytics at three scopes: the whole organization, a single link, or a campaign. All analytics endpoints are read-only and are subject to your plan's retention window.

Analytics are read-only and available at three scopes:

| Scope | Prefix | Answers |
| - | - | - |
| Organization | `get_org_*` | How is everything performing? |
| Link | `get_shortlink_*` | How is this one link performing? |
| Campaign | `get_campaign_*` | How is this campaign performing? |

All three accept the same filters — `date_from`, `date_to`, `granularity`, and
dimension filters such as `countries`, `devices` and `referrers` — so a query
written for one scope transfers to the others.

> [!NOTE]
>
> **Retention.** Your plan decides how far back you can look: 1 month on Free
> through to unlimited on Enterprise. A window reaching past your limit is moved
> forward rather than rejected, and the response carries a `retention` block
> saying so. See [Retention](https://docs.dashlink.ai/guides/analytics/retention.md).

> [!TIP]
>
> Fetching several metrics? `get_org_metrics_batch` returns them in one request
> instead of one request per metric.

## Endpoints

| Endpoint | Method | Description |
| - | - | - |
| [`/api/v1/analytics/get_org_kpis`](https://docs.dashlink.ai/api-reference/analytics/get-org-kpis) | `GET` | Retrieve organization KPIs |
| [`/api/v1/analytics/get_org_clicks_users_over_time`](https://docs.dashlink.ai/api-reference/analytics/get-org-clicks-users-over-time) | `GET` | Organization clicks and visitors over time |
| [`/api/v1/analytics/get_org_clicks_by_hour`](https://docs.dashlink.ai/api-reference/analytics/get-org-clicks-by-hour) | `GET` | Organization clicks by hour of day |
| [`/api/v1/analytics/get_org_metrics_aggregation`](https://docs.dashlink.ai/api-reference/analytics/get-org-metrics-aggregation) | `GET` | Organization metric breakdown |
| [`/api/v1/analytics/get_org_metrics_batch`](https://docs.dashlink.ai/api-reference/analytics/get-org-metrics-batch) | `GET` | Several organization metrics in one request |
| [`/api/v1/analytics/get_org_metric_filter_values`](https://docs.dashlink.ai/api-reference/analytics/get-org-metric-filter-values) | `GET` | Available filter values for a metric |
| [`/api/v1/analytics/get_org_routing_analytics`](https://docs.dashlink.ai/api-reference/analytics/get-org-routing-analytics) | `GET` | Organization routing-rule performance |
| [`/api/v1/analytics/get_shortlink_clicks_users_over_time`](https://docs.dashlink.ai/api-reference/analytics/get-shortlink-clicks-users-over-time) | `GET` | Link clicks and visitors over time |
| [`/api/v1/analytics/get_shortlink_clicks_by_hour`](https://docs.dashlink.ai/api-reference/analytics/get-shortlink-clicks-by-hour) | `GET` | Link clicks by hour of day |
| [`/api/v1/analytics/get_shortlink_metrics_aggregation`](https://docs.dashlink.ai/api-reference/analytics/get-shortlink-metrics-aggregation) | `GET` | Link metric breakdown |
| [`/api/v1/analytics/get_shortlink_routing_analytics`](https://docs.dashlink.ai/api-reference/analytics/get-shortlink-routing-analytics) | `GET` | Link routing-rule performance |
| [`/api/v1/analytics/get_shortlink_password_attempts`](https://docs.dashlink.ai/api-reference/analytics/get-shortlink-password-attempts) | `GET` | Link password attempts |
| [`/api/v1/analytics/get_campaign_analytics`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-analytics) | `GET` | Campaign analytics summary |
| [`/api/v1/analytics/get_campaign_analytics_details`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-analytics-details) | `GET` | Campaign metric detail |
| [`/api/v1/analytics/get_campaign_metrics_aggregation`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-metrics-aggregation) | `GET` | Campaign metric breakdown |
| [`/api/v1/analytics/get_campaign_clicks_users_over_time`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-clicks-users-over-time) | `GET` | Campaign clicks and visitors over time |
| [`/api/v1/analytics/get_campaign_clicks_by_hour`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-clicks-by-hour) | `GET` | Campaign clicks by hour of day |
| [`/api/v1/analytics/get_campaign_users_over_time`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-users-over-time) | `GET` | Campaign visitors over time |
| [`/api/v1/analytics/get_campaign_routing_analytics`](https://docs.dashlink.ai/api-reference/analytics/get-campaign-routing-analytics) | `GET` | Campaign routing-rule performance |
| [`/api/v1/analytics/download_org_analytics_report_latest`](https://docs.dashlink.ai/api-reference/analytics/download-org-analytics-report-latest) | `GET` | Download an organization analytics report |
| [`/api/v1/analytics/download_shortlink_analytics_report_latest`](https://docs.dashlink.ai/api-reference/analytics/download-shortlink-analytics-report-latest) | `GET` | Download a link analytics report |
| [`/api/v1/analytics/download_campaign_analytics_report`](https://docs.dashlink.ai/api-reference/analytics/download-campaign-analytics-report) | `GET` | Download a campaign analytics report |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.