HOhootsuite
Analytics

List Paid campaigns, ad sets, or ads

Returns paid entities for the collection given in the path (campaigns, adsets, or ads). Use query parameters for ad account type, pagination, and datatype; 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').

post/v1/analytics/paid/{adEntityCollection}

Request

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

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

Paid entity collection to list (campaigns, adsets, or ads). Must match the {adEntityType} path segment.

Query parameters

datatype'ORGANIC' | 'PAID'

API code for this datatype

The datatype to retrieve analytics for.

adAccountType'FACEBOOK' | 'TWITTER'

Ad account network type

The ad account type to retrieve analytics for.

cursorstring

Cursor for pagination, provided by a previous call.

limitinteger

Number of results to return in this page of data.

Request body

Example request

{
  "filters": {
    "lastModified": {
      "timespan": {
        "since": "2025-01-01",
        "until": "2025-02-28"
      }
    },
    "reportingPeriod": {
      "timespan": {
        "since": "2025-01-01",
        "until": "2025-02-28"
      }
    }
  }
}

Response

data successfully returned for the selected paid entity collection.

Example response

{
  "metadata": {
    "collectionInfo": {
      "next": {
        "cursor": "aWQ9NTAK"
      },
      "prev": {
        "cursor": "aWQ9NTAK"
      }
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.