Sign in
statistics

Stats API

get/stats

Query parameters

typestring

The type of stat to return. Layout|Media|Widget

fromDtstring

The start date for the filter. Default = 24 hours ago

toDtstring

The end date for the filter. Default = now.

statDatestring

The statDate filter returns records that are greater than or equal a particular date

statIdstring

The statId filter returns records that are greater than a particular statId

displayIdinteger

An optional display Id to filter

displayIdsinteger[]

An optional array of display Id to filter

layoutIdinteger[]

An optional array of layout Id to filter

parentCampaignIdinteger

An optional Parent Campaign ID to filter

mediaIdinteger[]

An optional array of media Id to filter

campaignIdinteger

An optional Campaign Id to filter

returnDisplayLocalTimeboolean

true/1/On if the results should be in display local time, otherwise CMS time

returnDateFormatstring

A PHP formatted date format for how the dates in this call should be returned.

embedstring

Should the return embed additional data, options are layoutTags,displayTags and mediaTags

Response

successful operation

typestring

Class Stats

displaystring
displayIdinteger
layoutstring
layoutIdinteger
mediastring
mediaIdinteger
widgetIdinteger
scheduleIdinteger
numberPlaysinteger
durationinteger
startstring
endstring
statDatestring
tagstring

Changes

Changed in 4 of the 52 revisions of this API.156

  • 41c04de98ec51See the full diff
    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c902f0bc774c1See the full diff
    • ○

      added the new optional query request parameter parentCampaignId

      new-optional-request-parameter

  • 59a66c27e8e84See the full diff
    • ○

      added the new optional query request parameter displayIds

      new-optional-request-parameter

    • ○

      added the new optional query request parameter embed

      new-optional-request-parameter

    • ○

      added the new optional query request parameter returnDateFormat

      new-optional-request-parameter

    • ○

      added the new optional query request parameter returnDisplayLocalTime

      new-optional-request-parameter

  • 8e127539510415See the full diff
    • ▲

      removed the media type application/json for the response with the status 200

      response-media-type-removed

    • ●

      deleted the query request parameter displayIds

      request-parameter-removed

    • ●

      deleted the query request parameter embed

      request-parameter-removed

    • ●

      deleted the query request parameter parentCampaignId

      request-parameter-removed

    • ●

      deleted the query request parameter returnDateFormat

      request-parameter-removed

    • ●

      deleted the query request parameter returnDisplayLocalTime

      request-parameter-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog