support Contact Support | system status System Status
Page Contents

    Dimension: date_hour

    The date_hour dimension provides analytics data in hourly segments. The user can specify the from and to parameters in yyyy-MM-dd or epoch time in milliseconds format. To report over a span of hours, you will need to use the milliseconds format, with to and from values falling within the start and end hours that you want to query on. Any date range specified by the user will be interpreted to the current timezone for the account. date_hour reports are only valid for ranges within the past 32 days. If the from value is more than 32 days ago, an error will be returned.

    Overview

    The date_hour dimension provides analytics data in hourly segments. The user can specify the from and to parameters in yyyy-MM-dd or epoch time in milliseconds format. To report over a span of hours, you will need to use the milliseconds format, with to and from values falling within the start and end hours that you want to query on. Any date range specified by the user will be interpreted to the current timezone for the account. date_hour reports are only valid for ranges within the past 32 days. If the from value is more than 32 days ago, an error will be returned.

    URL parameters

    Analytics API reports support the following URL parameters.

    URL Parameters
    Parameter Description Required Values Default
    account The accounts you want to report on yes one or more account ids as a comma-delimited list none
    dimensions The dimension(s) to report on yes one or more dimensions as a comma-delimited list (some combinations are not valid) none
    limit Number of items to return no positive integer 10
    offset Number of items to skip no positive integer 0
    sort Field to sort items on no a valid field for the request video_view
    fields Fields to return no varies according to the dimension you are reporting on video_view
    format Format to return results in no json | csv | xlxs json
    from The beginning of the date range for the request no An ISO 8601 date (YYYY-MM-DD), epoch time in milliseconds, the string alltime, or relative date (-1m); only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false. 30 days prior to now
    to The end of the date range for the request no An ISO 8601 date (YYYY-MM-DD), epoch time in milliseconds, the string now, or relative data (+7d); only dates within the past 32 days are allowed for engagement endpoints or if reconciled=false. now

    Fields available

    The following fields can be returned for the dimension.

    • ad_mode_begin - the number of times the player entered ad mode
    • ad_mode_complete - the number of times the player completed ad mode
    • date_hour - the date-time in ISO 8601 date-time format
    • engagement_score - the average engagement score for videos
    • play_request - total number of times video playback was requested
    • play_rate - the average play rate (video views divided by impressions) for videos
    • player_load - the total number of player loads
    • video_impression - the total number of times videos were loaded into players
    • video_percent_viewed - total percent viewed for all video views (a sum, not an average)
    • video_seconds_viewed - the total seconds viewed for all videos
    • video_view - the total number of times video playback began

    Filter values

    Used as a filter, a dimension allows you to narrow the results.

    Filter values: The date_hour dimension is not used as a filter.

    Combining dimensions

    To see what dimensions this on can be combined with, and what fields are available for the combination, see Dimension and Fields.

    Request Examples

    Dimension request

        https://analytics.api.brightcove.com/v1/data?accounts=1752604059001&dimensions=date_hour&from=-6h

    Filter request

        Not applicable

    Response

        Response will appear here when you test a request

    Page last updated on 12 Jun 2020