HOhootsuite
Analytics

List Profiles and Metrics

Fetch daily analytics metrics for profiles on this social network. profileId is a required filter, the others are optional. lastModified may start at most 30 days in the past. reportingPeriod may start at most 2 years in the past.

post/v1/analytics/profiles

Request

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

Query parameters

datatype'ORGANIC' | 'PAID'

API code for this datatype

The datatype to retrieve analytics for.

networkId'FACEBOOKPAGE' | 'TWITTER' | 'INSTAGRAMBUSINESS' | 'TIKTOKBUSINESS' | 'YOUTUBECHANNEL' | 'PINTEREST' | 'THREADS'

API code for this Social Network

The network 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": {
    "profileId": {
      "eq": "abc123",
      "in": [
        "abc123"
      ]
    },
    "lastModified": {
      "timespan": {
        "since": "2025-01-01",
        "until": "2025-02-28"
      }
    },
    "reportingPeriod": {
      "timespan": {
        "since": "2025-01-01",
        "until": "2025-02-28"
      }
    }
  }
}

Response

Profiles metrics returned.

Example response

{
  "data": [
    {
      "profileId": "12345678"
    }
  ],
  "metadata": {
    "collectionInfo": {
      "next": {
        "cursor": "aWQ9NTAK"
      },
      "prev": {
        "cursor": "aWQ9NTAK"
      }
    }
  }
}

Changes

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