---
title: "List Metrics for paid campaigns, ad sets, or ads"
method: POST
path: "/v1/analytics/paid/{adEntityCollection}/metrics"
tags: ["Analytics"]
---

# List Metrics for paid campaigns, ad sets, or ads

`POST /v1/analytics/paid/{adEntityCollection}/metrics`

## Request

- Base URL: `https://platform.hootsuite.com`
- URL: `https://platform.hootsuite.com/v1/analytics/paid/{adEntityCollection}/metrics`
- Auth: OAuth 2
  - Authorization code: `https://platform.hootsuite.com/oauth2/auth`
  - Token URL: `https://platform.hootsuite.com/oauth2/token`

Fetch daily metrics for the collection given in the path (`campaigns`,`adsets`, or `ads`) on the ad account  in the request body.
Use query parameters for ad account type, limit and pagination, and use the request body for filters (ad accounts, time range, etc.) note: In this API, 'adsets' and related response fields map to Facebook ad sets and Twitter ad groups ('adgroups').

## Path parameters

- `adEntityCollection` 'campaigns' | 'adsets' | 'ads', required: Plural collection name used in the URL path. Determines whether the response contains campaigns, ad sets, or ads

## Query parameters

- `datatype` 'ORGANIC' | 'PAID': API code for this datatype
- `adAccountType` 'FACEBOOK' | 'TWITTER': Ad account network type
- `cursor` string
- `limit` integer

## Request body

- ListPaidMetricsRequest
  - `filters` AdRequestFilters, required
    - `adAccounts` AdAccountFilter[], required
      - `adAccountId` string, required
      - `organizationId` string, required
    - `lastModified` TimeFieldFilters: Filter by a time field, at least one filter must be specified.
      - `timespan` TimespanFilter: Timespan to filter against, inclusive. At least one of `since` or `until` must be provided.
        - `since` string, date: Start of query, if omitted defaults to 1 year ago
        - `until` string, date: End of query, if omitted defaults to now
    - `reportingPeriod` TimeFieldFilters: Filter by a time field, at least one filter must be specified.
      - `timespan` TimespanFilter: Timespan to filter against, inclusive. At least one of `since` or `until` must be provided.
        - `since` string, date: Start of query, if omitted defaults to 1 year ago
        - `until` string, date: End of query, if omitted defaults to now

## Response `200`

Paid metrics returned

- ListPaidMetricsResponse
  - `data` union[], required
    - union
      - CampaignContentDailyMetrics: Daily metrics snapshot for a paid campaign.
        - `adAccountId` string, required: Internal identifier of the ad account.
        - `adAccountType` 'FACEBOOK' | 'TWITTER', required: Ad account network type
        - `organizationId` string, required: Hootsuite organization Id
        - `externalCampaignId` string, required: Campaign identifier from the external ad platform.
        - `externalAdAccountId` string, required: Account identifier from the external ad platform.
        - `date` string, date, required: Reporting date for this metrics record.
        - `metrics` MetricsPublic, required: All social network and Owly metrics in a single map. Keys are metric names (e.g. "likes", "comments", "post_views", "clicks"). Values are numeric (float64). For metric definitions, see the Help Center documentation.
      - AdsetContentDailyMetrics: Daily metrics snapshot for a paid ad set.
        - `adAccountId` string, required: Internal identifier of the ad account.
        - `adAccountType` 'FACEBOOK' | 'TWITTER', required: Ad account network type
        - `organizationId` string, required: Internal identifier of the owning organization.
        - `externalAdsetId` string, required: Ad set identifier from the external ad platform.
        - `externalCampaignId` string, required: Parent campaign identifier from the external ad platform.
        - `externalAdAccountId` string, required: Account identifier from the external ad platform.
        - `date` string, date, required: Reporting date for this metrics record.
        - `metrics` MetricsPublic, required: All social network and Owly metrics in a single map. Keys are metric names (e.g. "likes", "comments", "post_views", "clicks"). Values are numeric (float64). For metric definitions, see the Help Center documentation.
      - AdContentDailyMetrics: Daily metrics snapshot for a paid ad.
        - `adAccountId` string, required: Internal identifier of the ad account.
        - `adAccountType` 'FACEBOOK' | 'TWITTER', required: Ad account network type
        - `organizationId` string, required: Hootsuite Organization Id
        - `externalAdId` string, required: Ad identifier from the external ad platform.
        - `externalAdsetId` string, required: Parent ad set identifier from the external ad platform.
        - `externalCampaignId` string, required: Parent campaign identifier from the external ad platform.
        - `externalAdAccountId` string, required: Account identifier from the external ad platform.
        - `date` string, date, required: Reporting date for this metrics record.
        - `metrics` MetricsPublic, required: All social network and Owly metrics in a single map. Keys are metric names (e.g. "likes", "comments", "post_views", "clicks"). Values are numeric (float64). For metric definitions, see the Help Center documentation.
  - `metadata` Metadata, required
    - `collectionInfo` CollectionInfo, required
      - `next` Cursor
        - `cursor` string, required: Cursor for the next/prev page of data, if available
      - `prev` Cursor
        - `cursor` string, required: Cursor for the next/prev page of data, if available

## Other responses

- `default`: An error occurred.

---

[API](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api.md) - [All operations](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hootsuite/apis/hootsuite-rest-api/revisions/adac53bd28bb?raw)