Endpoints - Aggregated

Avatar
Francesco
Follow

Aggregated Reports

 

Model

An aggregated report is an entity containing a snapshot about either a datapoint/group/customer/conversion related to theyr broad aspects (hits, unique hits, spiders, conversion count, …).

Some fields are maked as optional as in they don’t need to be present in a minimum working report.

 

AggregatedResult {

commissionsCost (integer, optional): ,

conversionsCost (integer, optional): ,

conversionsCount (integer, optional): Total number of conversions,

conversionsValue (string, optional): ,

uniqueConvertedClicks (integer, optional): Number of clicks that got uniquely converted,

entityId (integer): Id of the entity this object refers to,

entityData (object, optional): An object representing a entity relevant properties,

spiderHitsCount (string, optional): Total number of spider hits (view + click),

fromDay (string, optional): The starting date to which this aggregated refers to,

toDay (string, optional): The ending date to which this aggregated refers to,

totalClicks (integer, optional): Total number of clicks,

totalViews (integer, optional): Total number of views,

uniqueClicks (integer, optional): Number of unique clicks,

uniqueViews (integer, optional): Number of unique views,

lastHitDate (string, optional): Last hit date related to this report,

hourlyBreakDown (array[AggregatedResult], optional): If an hourly breakdown was requested, this will contain an array of hours with the necessary stats.

}

 

AggregatedSummaryResult {

count (integer): Total count of elements for request,

limit (integer): Limit used,

offset (integer): Offset used,

fromDay (string, optional): The starting date to which this aggregated refers to,

toDay (string, optional): The ending date to which this aggregated refers to,

result (array[AggregatedResult], optional): List of resulting objects

}



Aggregated report types

A report always contains the data about the particular entity selected (or group of), in a select predefinied timeframe or a custom timeframe. For timeframes related to current day and/or the day before an hourly breakdown is available.




GET /aggregated

Retrieve the aggregated report for the current authenticated user.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • withHourly [optional] [boolean,false] : Request an hourly breakdown, if possible.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [stringl] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

 

GET /aggregated/list

Retrieve the aggregated reports for the current authenticated user, with details for the granularity selected.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: List of AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • groupBy [optional/required] [string] : Can select the granularity of the list “day, week, month”. BEWARE in “beginning” timeframe you must set this to “month”

 

GET /datatpoints/{id}/aggregated

Retrieve the aggregated report for the current authenticated user about the datapoint {id}.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • hourly [optional] [boolean,false] : Request an hourly breakdown, if possible.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

 

GET /datatpoints/{id}/aggregated/list

Retrieve the aggregated reports for the current authenticated user about the datapoint {id}, with details for the granularity selected.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: List of AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • groupBy [optional/required] [string] : Can select the granularity of the list “day, week, month”. BEWARE in “beginning” timeframe you must set this to “month”

 

GET /datatpoints/aggregated/list

Retrieve the aggregated reports for the current authenticated user about filtered datapoint, with details for the granularity selected.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: List of AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • status [optional] [string, all] : Filter by the status of the entities contained in this group (deleted, paused, spam, active, all)

  • favourite [optional] [boolean] : Filter by favourite status

  • tag [optional] [string] : Filter by tag name

  • type [required] [string]: Type of datapoint (TP, TL)

  • groupBy [optional/required] [string] : Can select the granularity of the list “day, week, month”. BEWARE in “beginning” timeframe you must set this to “month”

  • offset [optional] [integer, 0] : Where to start when retrieving data

  • limit [optional] [integer, 20] : Maximum elements to retrieve

 

GET /groups/{id}/aggregated

Retrieve the aggregated report for the current authenticated user about the group {id}.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • hourly [optional] [boolean,false] : Request an hourly breakdown, if possible.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • status [optional] [string, all] : Filter by the status of the entities contained in this group (deleted, paused, spam, active, all)

 

GET /groups/{id}/aggregated/list

Retrieve the aggregated reports for the current authenticated user about the group {id}, with details for the granularity selected.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: List of AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • groupBy [optional/required] [string] : Can select the granularity of the list “day, week, month”. BEWARE in “beginning” timeframe you must set this to “month”

  • status [optional] [string, all] : Filter by the status of the entities contained in this group (deleted, paused, spam, active, all)

 

GET /groups/aggregated/list

Retrieve the aggregated reports for the current authenticated user about filtered groups, with details for the granularity selected.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: List of AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • status [optional] [string, all] : Filter by the status of the entities contained in this group (deleted, active, all)

  • favourite [optional] [boolean] : Filter by favourite status

  • tag [optional] [string] : Filter by tag name

  • groupBy [optional/required] [string] : Can select the granularity of the list “day, week, month”. BEWARE in “beginning” timeframe you must set this to “month”

  • offset [optional] [integer, 0] : Where to start when retrieving data

  • limit [optional] [integer, 20] : Maximum elements to retrieve

 

GET /conversions/{id}/aggregated

Retrieve the aggregated report for the current authenticated user about the conversion {id}.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

 

GET /conversions/{id}/aggregated/list

Retrieve the aggregated reports for the current authenticated user about the conversion {id}, with details for the granularity selected.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: List of AggregatedResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • groupBy [optional/required] [string] : Can select the granularity of the list “day, week, month”. BEWARE in “beginning” timeframe you must set this to “month”

 

GET /aggregated/summary/datapoints

Retrieve the aggregated reports for the current authenticated user about filtered datapoints, with details for the entities.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedSummaryResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • status [optional] [string, all] : Filter by the status of the entities (deleted, paused, spam, active, all)

  • favourite [optional] [boolean] : Filter by favourite status

  • tag [optional] [string] : Filter by tag name

  • type [required] [string]: Type of datapoint (TP, TL)

  • offset [optional] [integer, 0] : Where to start when retrieving data

  • limit [optional] [integer, 20] : Maximum elements to retrieve

  • sortDirection [string, optional]: Sort “asc” or “desc”

  • sortBy [optional, string]: Sort by this particular field

    • totalclicks

    • totalviews

    • uniqueclicks

    • uniqueviews

    • conversionsvalue

    • convertedclicks

    • spiderhitscount

    • entityData.datapointname

    • entityData.creationdate

 

GET /aggregated/summary/groups

Retrieve the aggregated reports for the current authenticated user about filtered groups, with details for the entities.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedSummaryResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • status [optional] [string, all] : Filter by the status of the entities (deleted, active, all)

  • favourite [optional] [boolean] : Filter by favourite status

  • tag [optional] [string] : Filter by tag name

  • offset [optional] [integer, 0] : Where to start when retrieving data

  • limit [optional] [integer, 20] : Maximum elements to retrieve

  • sortDirection [string, optional]: Sort “asc” or “desc”

  • sortBy [optional, string]: Sort by this particular field

    • totalclicks

    • totalviews

    • uniqueclicks

    • uniqueviews

    • conversionsvalue

    • convertedclicks

    • spiderhitscount

    • entityData.groupname

    • entityData.creationdate

 

GET /aggregated/summary/conversions

Retrieve the aggregated reports for the current authenticated user about filtered conversions, with details for the entities.

This endpoint has optional filters that can be used in the GET request to change its response behaviour.

Result: AggregatedSummaryResult

Filters:

  • timeframe [required] [string] : Timeframe "today,yesterday,last7,last30,last90,beginning,custom". If "custom" use fromDay-toDay.

  • fromDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • toDay [optional] [string] : Custom timeframe, you can select a range in the last 90 or 30 days. A date in the format YYYYMMDDHHmm.

  • status [optional] [string, all] : Filter by the status of the entities (deleted, active, all)

  • favourite [optional] [boolean] : Filter by favourite status

  • offset [optional] [integer, 0] : Where to start when retrieving data

  • limit [optional] [integer, 20] : Maximum elements to retrieve

  • sortDirection [string, optional]: Sort “asc” or “desc”

  • sortBy [optional, string]: Sort by this particular field

    • count

    • lasthitdate

    • entityData.name

    • entityData.value

    • entityData.creationdate

 

For more info read this FAQ: 

Have more questions? Submit a request

0 Comments

Article is closed for comments.