メインコンテンツへスキップ
GET
/
analytics
/
v2
/
reports
/
{breakdown_by}
/
{time_period}
Get analytics data breakdowns
curl --request GET \
  --url https://api.hubapi.com/analytics/v2/reports/{breakdown_by}/{time_period}
{
  "offset": 123,
  "total": 123,
  "totals": {
    "rawViews": 123,
    "visits": 123,
    "visitors": 123,
    "leads": 123,
    "contacts": 123,
    "subscribers": 123,
    "marketingQualifiedLeads": 123,
    "salesQualifiedLeads": 123,
    "opportunities": 123,
    "customers": 123,
    "pageviewsPerSession": 123,
    "bounceRate": 123,
    "timePerSession": 123,
    "newVisitorSessionRate": 123,
    "sessionToContactRate": 123,
    "contactToCustomerRate": 123,
    "ctaViews": 123,
    "submissions": 123,
    "entrances": 123,
    "exits": 123,
    "timePerPageview": 123,
    "pageBounceRate": 123,
    "exitsPerPageview": 123
  },
  "breakdowns": [
    {
      "rawViews": 123,
      "visits": 123,
      "visitors": 123,
      "leads": 123,
      "contacts": 123,
      "subscribers": 123,
      "marketingQualifiedLeads": 123,
      "salesQualifiedLeads": 123,
      "opportunities": 123,
      "customers": 123,
      "pageviewsPerSession": 123,
      "bounceRate": 123,
      "timePerSession": 123,
      "newVisitorSessionRate": 123,
      "sessionToContactRate": 123,
      "contactToCustomerRate": 123,
      "ctaViews": 123,
      "submissions": 123,
      "entrances": 123,
      "exits": 123,
      "timePerPageview": 123,
      "pageBounceRate": 123,
      "exitsPerPageview": 123,
      "breakdown": "<string>",
      "meta": "<string>"
    }
  ]
}

パスパラメータ

breakdown_by
enum<string>
必須

The category used to break down the analytics data.

利用可能なオプション:
totals,
sessions,
sources,
geolocation,
utm-campaigns,
utm-contents,
utm-mediums,
utm-sources,
utm-terms
time_period
enum<string>
必須

The time period used to group the data.

利用可能なオプション:
total,
daily,
weekly,
monthly,
summarize/daily,
summarize/weekly,
summarize/monthly

クエリパラメータ

start
string
必須

The start date for the data you want. Must be included as ISO 8601 format, YYYYMMDD.

Pattern: ^\d{8}$
end
string
必須

The end date for the data you want. Must be included as ISO 8601 format, YYYYMMDD.

Pattern: ^\d{8}$
d1
string

Used to drilldown into the data.

d2
string

Used to further drill down into the data.

f
string[]

Filter the returned data to include only the specified breakdown. May be included multiple times.

e
string[]

Exclude data for the specified breakdown. May be included multiple times.

filterId
integer

The ID of an Analytics view.

sort
string

If included, the results are sorted by the specified field.

sortDir
enum<string>
デフォルト:DESC

Controls the direction of sorted results.

利用可能なオプション:
ASC,
DESC
limit
integer
デフォルト:350

Used to limit the number of results per request.

offset
integer

Used to get the next page of results.

レスポンス

Analytics data retrieved successfully

offset
integer

The offset for pagination

total
integer

The total number of results

totals
object
breakdowns
object[]
Last modified on April 13, 2026