API ReferenceAnnouncementsCommunity Discussion
API ReferenceCommunity DiscussionAnnouncementsSubscribeLog In
Announcements
fixed

`by_hour_of_day` dimension - end_date

To fetch data by hour, aggregated over a given date range, use the by_hour_of_day dimension.

Going forward, use an inclusive end_date with this dimension.

Example

To aggregate data by hour, from 2020-06-01 - 2020-06-07, use this query:

GET /backstage/api/1.0/demo-account/reports/campaign-summary/dimensions/by_hour_of_day?start_date=2020-06-01&end_date=2020-06-07

📘

The report returns 24 rows, each one with aggregated data for that hour of the day.

🚧

Guidelines

  1. The end_date is inclusive.
  2. You can optionally filter on a given campaign.
  3. Hourly data is not available in real time. Allow 1 - 2 hours for data to become available.
  4. Reporting data is retained for 90 days.

📘

See also

To fetch hourly data per campaign, use the campaign_hour_breakdown dimension. For more detail, see this announcement.

📘

Default times

The following default times are applied to the date range:

  • start_date - default time is 00:00:00
  • end_date - default time is 23:59:59

You can override these defaults by passing a specific time. (The values passed should reflect the time zone of that account.)