Endpoints - Reports

Reports

 

Model

A report is an entity contain statistics about either a datapoint/group/customer/conversion related to some particular aspect.

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

 

TopReport {

createdAt (string, optional): Timestamp of top creation,

data (array[TopReportDetail]): List of TopReportDetail

}

TopReportDetail {

id (string): A string representing the value being analyzed in the report,

totalHits (integer): Total number of hits,

spiderHits (integer, optional): Spider hits,

uniqueHits (integer, optional): Unique hits,

entityData (object): Variable section, with detailed data about the id,

lastHitDate (string): Last hit event for this object

}

 

Report types

You can select the report type by specifying it into the query. The available types with the correct key in square brackets are:

  • Browser [browsers]

  • Browser Families [browsersfamilies]

  • Operating Systems [oss]

  • Operating Systems Families [osfamilies]

  • Countries [countries]

  • Cities [cities]

  • IP [ips]

  • ISP [isps]

  • Referrers [referers]



Report timeframe

You can select, also, the timeframe for which you want to see the report by specifying it into the query. The available types with the correct key in square brackets are:

  • Yesterday [yesterday]

  • Last seven days [last7]

  • Last thirty days [last30]

  • Last ninty days [last90]

  • From the entity creation [beginning]

  • Custom timeframe to be specified with other parameters [custom]

 

GET /reports

Retrieve a report associated to the current authenticated user.

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

Result: TopReport

Filters:

  • type [mandatory] [string] : Type of report

  • timeframe [mandatory] [string] : Timeframe of report

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

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

  • datapoint [optional] [integer] : Id of the datapoint. Mutually exclusive with group

  • group [optional] [integer] : Id of the group. Mutually exclusive with datapoint

 

GET /groups/{id}/reports

Retrieve a report associated to the current authenticated user for the group {id}.

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

Result: TopReport

Filters:

  • type [mandatory] [string] : Type of report

  • timeframe [mandatory] [string] : Timeframe of report

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

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

 

GET /datapoints/{id}/reports

Retrieve a report associated to the current authenticated user for the datapoint {id}.

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

Result: TopReport

Filters:

  • type [mandatory] [string] : Type of report

  • timeframe [mandatory] [string] : Timeframe of report

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

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

 

GET /conversions/{id}/reports

Retrieve a report associated to the current authenticated user for the conversion {id}.

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

Result: TopReport

Filters:

  • type [mandatory] [string] : Type of report

  • timeframe [mandatory] [string] : Timeframe of report

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

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

 

For more info read this FAQ: 

Have more questions? Submit a request

0 Comments

Article is closed for comments.