Endpoints - Clickstream & HitList

Model(s)

Clickstream and Hits List refers to a common model, the difference between these two areas, is only about the quantity and the timeframe of data: while in a clickstream the number of hits is fixed and the timeframe is always the latest, in a hits list you can decide quantity and timeframe.

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

 

Timeframe(s)

Hits List needs a timeframe parameter to specify the range of the hits you want to be retuned (time-wise). The allowed timeframes are:

  • today
  • yesterday
  • last7 (last seven days)
  • last30
  • last90
  • last120
  • last180
  • currentmonth
  • previousmonth
  • custom (to be used with the params fromDay/toDay)

 

Main Models

Clickstream {

rows (array[ClickstreamRow]):

}

 

HitList {

lastKey (string, optional): Last row key retrieved. For successive calls with offset field,

hits (array[ClickstreamRow]): Hits in this request

}

 

ClickstreamRow {

accessTime (string): Date of the hit,

ip (string, optional): Ip associated to the hit,

type (string, optional): Type of hit (Click/View),

isSpider (boolean): Hit was from a spider,

isUnique (boolean): Hit was unique,

queryParams (string, optional): Parameters of the query in this hit,

referer (string, optional): Referer URL for this hit,

sourceId (integer, optional): Source of the hit (enumeration for common sources),

entity (ClickStreamEntity): Entity associated to the hit,

browser (BrowserIdentifier, optional): Browser associated to the hit,

location (Location): Location associated to the hit,

conversions (array[ConversionValue], optional): Eventual conversions associated with the hit,

os (OperatingSystem, optional): Operating system associated to the hit

}

 

Helper Models

ClickStreamEntity {

creationDate (string, optional): Date of creation,

datapointFavourite (boolean, optional): Is the datapoint marked as “favourite”,

datapointId (integer, optional): Id of the related datapoint,

datapointName (string, optional): Name of the related datapoint,

datapointType (string, optional): Type of the related datapoint,

groupId (string, optional): Id of the related group,

groupName (string, optional): Name of the related group

}

 

BrowserIdentifier {

id (integer): Id of the browser,

name (string): Name of the browser,

familyId (integer, optional): Id of the family,

familyName (string, optional): Name of the family

}

 

Location {

country (string): Country in ISO code,

areacode (string, optional): Area code,

city (string, optional): City name,

latitude (integer, optional): Latitude,

longitude (integer, optional): Longitude,

metrocode (string, optional): Metropolitan code,

organization (string, optional): Possible description of the owner,

postalcode (string, optional): Postalcode of the hit,

region (string, optional): Region of the hit

}

 

ConversionValue {

comcost (integer): Value of the conversion commission,

cost (integer): Value of the conversion,

date (string): Date on which the conversion was created,

id (integer): Id of the conversion,

dateUTC (string, optional): Date (UTC) on which the conversion was created,

parameter (string): Parameters of the conversion,

source (string): Source of the conversion

}

 

OperatingSystem {

id (integer): Id of the operating system,

name (string): Name of the operating system,

familyId (integer, optional): Id of the family,

familyName (string, optional): Name of the family of operating system

}

 

GET /clickstream

Retrieve the clickstream to the current authenticated user.

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

Result: Clickstream

Filters:

  • fields [optional] [string] : Comma separated list of fields to retrieve (default retrieves all).

  • withConversion [optional] [boolean] : Add conversion data

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

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

 

GET /datapoints/{id}/hits

Retrieve the events list for the current authenticated user related to the datapoint {id}.

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

Result: HitList

Filters:

  • offset [optional] [string, 0] : Where to start when retrieving hits (HitList.lastKey)

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

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

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

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

 

GET /groups/{id}/hits

Retrieve the events list for the current authenticated user related to the group {id}.

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

Result: HitList

Filters:

  • offset [optional] [string, 0] : Where to start when retrieving hits (HitList.lastKey)

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

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

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

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

 

GET /conversions/{id}/hits

Retrieve the events list for the current authenticated user related to the conversion {id}.

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

Result: HitList

Filters:

  • offset [optional] [string, 0] : Where to start when retrieving hits (HitList.lastKey)

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

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

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

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

 

 

GET /hits

Retrieve the clickstream for the current authenticated user.

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

Result: HitList

Filters:

  • offset [optional] [string, 0] : Where to start when retrieving hits (HitList.lastKey)

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

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

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

  • toDay [optional] [string, all] : If the timeframe is set to "custom", here you can select a range in the last 180 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.