6.0.0 • Published 5 years ago

@datafire/clickmeter v6.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/clickmeter

Client library for ClickMeter

Installation and Usage

npm install --save @datafire/clickmeter
let clickmeter = require('@datafire/clickmeter').create({
  api_key: ""
});

.then(data => {
  console.log(data);
});

Description

Api dashboard for ClickMeter API

Actions

account.get

Retrieve current account data

clickmeter.account.get(null, context)

Input

This action has no parameters

Output

account.post

Update current account data

clickmeter.account.post({
  "value": {}
}, context)

Input

Output

account.domainwhitelist.get

Retrieve list of a domains allowed to redirect in DDU mode

clickmeter.account.domainwhitelist.get({}, context)

Input

  • input object
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number

Output

account.domainwhitelist.post

Create an domain entry

clickmeter.account.domainwhitelist.post({
  "value": {}
}, context)

Input

Output

account.domainwhitelist.whitelistId.delete

Delete an domain entry

clickmeter.account.domainwhitelist.whitelistId.delete({
  "whitelistId": ""
}, context)

Input

  • input object
    • whitelistId required string: The id of the domain to delete

Output

account.guests.get

Retrieve list of a guest

clickmeter.account.guests.get({}, context)

Input

  • input object
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • textSearch string: Filter fields by this pattern

Output

account.guests.post

Create a guest

clickmeter.account.guests.post({
  "value": {}
}, context)

Input

Output

account.guests.count.get

Retrieve count of guests

clickmeter.account.guests.count.get({}, context)

Input

  • input object
    • textSearch string: Filter fields by this pattern

Output

account.guests.guestId.delete

Delete a guest

clickmeter.account.guests.guestId.delete({
  "guestId": 0
}, context)

Input

  • input object
    • guestId required integer: Id of the guest

Output

account.guests.guestId.get

Retrieve a guest

clickmeter.account.guests.guestId.get({
  "guestId": 0
}, context)

Input

  • input object
    • guestId required integer: Id of the guest

Output

account.guests.guestId.post

Update a guest

clickmeter.account.guests.guestId.post({
  "guestId": 0,
  "value": {}
}, context)

Input

Output

account.guests.guestId.permissions.get

Retrieve permissions for a guest

clickmeter.account.guests.guestId.permissions.get({
  "guestId": 0
}, context)

Input

  • input object
    • guestId required integer: Id of the guest
    • entityType string (values: datapoint, group): Can be "datapoint" or "group"
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • type string (values: r, w): Can be "w" or "r"
    • entityId integer: Optional id of the datapoint/group entity to filter by

Output

account.guests.guestId.permissions.count.get

Retrieve count of the permissions for a guest

clickmeter.account.guests.guestId.permissions.count.get({
  "guestId": 0
}, context)

Input

  • input object
    • guestId required integer: Id of the guest
    • entityType string (values: datapoint, group): Can be "datapoint" or "group"
    • type string (values: r, w): Can be "w" or "r"
    • entityId integer: Optional id of the datapoint/group entity to filter by

Output

account.guests.guestId.type.permissions.patch.post

Change the permission on a shared object

clickmeter.account.guests.guestId.type.permissions.patch.post({
  "guestId": 0,
  "type": "",
  "body": {}
}, context)

Input

Output

account.guests.guestId.type.permissions.patch.put

Change the permission on a shared object

clickmeter.account.guests.guestId.type.permissions.patch.put({
  "guestId": 0,
  "type": "",
  "body": {}
}, context)

Input

Output

account.ipblacklist.get

Retrieve list of a ip to exclude from event tracking

clickmeter.account.ipblacklist.get({}, context)

Input

  • input object
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number

Output

account.ipblacklist.post

Create an ip blacklist entry

clickmeter.account.ipblacklist.post({
  "value": {}
}, context)

Input

Output

account.ipblacklist.blacklistId.delete

Delete an ip blacklist entry

clickmeter.account.ipblacklist.blacklistId.delete({
  "blacklistId": ""
}, context)

Input

  • input object
    • blacklistId required string: The id of the ip to delete

Output

account.plan.get

Retrieve current account plan

clickmeter.account.plan.get(null, context)

Input

This action has no parameters

Output

aggregated.get

Retrieve statistics about this customer for a timeframe

clickmeter.aggregated.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • hourly boolean: If using "yesterday" or "today" timeframe you can ask for the hourly detail
    • onlyFavorites string

Output

aggregated.list.get

Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month)

clickmeter.aggregated.list.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • groupBy string (values: week, month): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

aggregated.summary.conversions.get

Retrieve statistics about a subset of conversions for a timeframe with conversions data

clickmeter.aggregated.summary.conversions.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string (values: deleted, active): Status of conversion ("deleted"/"active")
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • textSearch string: Filter fields by this pattern

Output

aggregated.summary.datapoints.get

Retrieve statistics about a subset of datapoints for a timeframe with datapoints data

clickmeter.aggregated.summary.datapoints.get({
  "timeFrame": "",
  "type": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • type required string (values: tp, tl): Type of datapoint ("tl"/"tp")
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string (values: deleted, active, paused, spam): Status of datapoint ("deleted"/"active"/"paused"/"spam")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the datapoint marked as favourite
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • groupId integer: Filter by this group id
    • textSearch string: Filter fields by this pattern

Output

aggregated.summary.groups.get

Retrieve statistics about a subset of groups for a timeframe with groups data

clickmeter.aggregated.summary.groups.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string (values: deleted, active): Status of group ("deleted"/"active")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the group marked as favourite
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • textSearch string: Filter fields by this pattern

Output

clickstream.get

Retrieve the latest list of events of this account. Limited to last 100.

clickmeter.clickstream.get({}, context)

Input

  • input object
    • group integer: Filter by this group id (mutually exclusive with "datapoint" and "conversion")
    • datapoint integer: Filter by this datapoint id (mutually exclusive with "group" and "conversion")
    • conversion integer: Filter by this conversion id (mutually exclusive with "datapoint" and "group")
    • pageSize integer: Limit results to this number
    • filter string (values: , spiders, uniques, nonuniques, conversions): Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")

Output

conversions.get

Retrieve a list of conversions

clickmeter.conversions.get({}, context)

Input

  • input object
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • status string (values: deleted, active): Status of conversion ("deleted"/"active")
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude conversions created before this date (YYYYMMDD)
    • createdBefore string: Exclude conversions created after this date (YYYYMMDD)

Output

conversions.post

Create a conversion

clickmeter.conversions.post({
  "value": {}
}, context)

Input

Output

conversions.aggregated.list.get

Retrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some temporal entity (day/week/month)

clickmeter.conversions.aggregated.list.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string (values: deleted, active): Status of conversion ("deleted"/"active")
    • groupBy string (values: week, month): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

conversions.count.get

Retrieve a count of conversions

clickmeter.conversions.count.get({}, context)

Input

  • input object
    • status string (values: deleted, active): Status of conversion ("deleted"/"active")
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude conversions created before this date (YYYYMMDD)
    • createdBefore string: Exclude conversions created after this date (YYYYMMDD)

Output

conversions.conversionId.delete

Delete conversion specified by id

clickmeter.conversions.conversionId.delete({
  "conversionId": 0
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion

Output

conversions.conversionId.get

Retrieve conversion specified by id

clickmeter.conversions.conversionId.get({
  "conversionId": 0
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion

Output

conversions.conversionId.post

Update conversion specified by id

clickmeter.conversions.conversionId.post({
  "conversionId": 0,
  "value": {}
}, context)

Input

Output

conversions.conversionId.aggregated.get

Retrieve statistics about this conversion for a timeframe

clickmeter.conversions.conversionId.aggregated.get({
  "conversionId": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • tag string: Filter by this tag name
    • favourite boolean: Is the datapoint marked as favourite
    • hourly boolean: If using "yesterday" or "today" timeframe you can ask for the hourly detail

Output

conversions.conversionId.aggregated.list.get

Retrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month)

clickmeter.conversions.conversionId.aggregated.list.get({
  "conversionId": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • groupBy string (values: week, month): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

conversions.conversionId.datapoints.get

Retrieve a list of datapoints connected to this conversion

clickmeter.conversions.conversionId.datapoints.get({
  "conversionId": 0
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • type string (values: tp, tl): Type of datapoint ("tl"/"tp")
    • status string (values: deleted, active, paused, spam): Status of datapoint ("deleted"/"active"/"paused"/"spam")
    • tags string: Filter by this tag name
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

conversions.conversionId.datapoints.batch.patch.put

Modify the association between a conversion and multiple datapoints

clickmeter.conversions.conversionId.datapoints.batch.patch.put({
  "conversionId": 0,
  "data": {}
}, context)

Input

Output

conversions.conversionId.datapoints.count.get

Retrieve a count of datapoints connected to this conversion

clickmeter.conversions.conversionId.datapoints.count.get({
  "conversionId": 0
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion
    • type string: Type of datapoint ("tl"/"tp")
    • status string: Status of datapoint ("deleted"/"active"/"paused"/"spam")
    • tags string: Filter by this tag name
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

conversions.conversionId.datapoints.patch.put

Modify the association between a conversion and a datapoint

clickmeter.conversions.conversionId.datapoints.patch.put({
  "conversionId": 0,
  "data": {}
}, context)

Input

Output

conversions.conversionId.hits.get

Retrieve the list of events related to this conversion.

clickmeter.conversions.conversionId.hits.get({
  "conversionId": 0,
  "timeframe": ""
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, custom): Timeframe of the request. See list at $timeframeList
    • limit integer: Limit results to this number
    • offset string: Offset where to start from (it's the lastKey field in the response object)
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • filter string (values: spiders, uniques, nonuniques, conversions): Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")

Output

conversions.conversionId.notes.put

Fast patch the "notes" field of a conversion

clickmeter.conversions.conversionId.notes.put({
  "conversionId": 0,
  "note": {}
}, context)

Input

Output

conversions.conversionId.reports.get

Retrieve a top report connected to this conversion

clickmeter.conversions.conversionId.reports.get({
  "conversionId": 0,
  "type": "",
  "timeframe": ""
}, context)

Input

  • input object
    • conversionId required integer: Id of the conversion
    • type required string (values: datapoints, groups, browsers, browsersfamilies, platforms, cities, countries, keywords, referrers, convparameters, destinations, languages, params): Type of the report.
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, beginning, custom): Timeframe of the request. See list at $timeframeList
    • hittype string (values: clicks, views): Type of the event you want to filter this report with. By default no filter is applied.
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)

Output

datapoints.get

List of all the datapoints associated to the user

clickmeter.datapoints.get({}, context)

Input

  • input object
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.
    • type string (values: tp, tl): Type of the datapoint ("tp"/"tl")
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • onlyFavorites boolean: Filter fields by favourite status
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

datapoints.post

Create a datapoint

clickmeter.datapoints.post({
  "value": {}
}, context)

Input

Output

datapoints.aggregated.get

Retrieve statistics about this customer for a timeframe by groups

clickmeter.datapoints.aggregated.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • type string (values: tp, tl): Type of datapoint ("tl"/"tp")
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • hourly boolean: If using "yesterday" or "today" timeframe you can ask for the hourly detail
    • status string (values: deleted, active, paused, spam): Status of datapoint ("deleted"/"active"/"paused"/"spam")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the datapoint is marked as favourite

Output

datapoints.aggregated.list.get

Retrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity (day/week/month)

clickmeter.datapoints.aggregated.list.get({
  "type": "",
  "timeFrame": ""
}, context)

Input

  • input object
    • type required string (values: tp, tl): Type of datapoint ("tl"/"tp")
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string (values: deleted, active, paused, spam): Status of datapoint ("deleted"/"active"/"paused"/"spam")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the datapoint is marked as favourite
    • groupBy string (values: week, month): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

datapoints.batch.delete

Delete multiple datapoints

clickmeter.datapoints.batch.delete({
  "batch": {}
}, context)

Input

Output

datapoints.batch.post

Update multiple datapoints

clickmeter.datapoints.batch.post({
  "batch": {}
}, context)

Input

Output

datapoints.batch.put

Create multiple datapoints

clickmeter.datapoints.batch.put({
  "batch": {}
}, context)

Input

Output

datapoints.count.get

Count the datapoints associated to the user

clickmeter.datapoints.count.get({}, context)

Input

  • input object
    • type string (values: tp, tl): Type of the datapoint ("tp"/"tl")
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • onlyFavorites boolean: Filter fields by favourite status
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

datapoints.id.delete

Delete a datapoint

clickmeter.datapoints.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The id of the datapoint

Output

datapoints.id.get

Get a datapoint

clickmeter.datapoints.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The id of the datapoint

Output

datapoints.id.post

Update a datapoint

clickmeter.datapoints.id.post({
  "id": 0,
  "value": {}
}, context)

Input

Output

datapoints.id.aggregated.get

Retrieve statistics about this datapoint for a timeframe

clickmeter.datapoints.id.aggregated.get({
  "id": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • id required integer: Id of the datapoint
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • hourly boolean: If using "yesterday" or "today" timeframe you can ask for the hourly detail

Output

datapoints.id.aggregated.list.get

Retrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month)

clickmeter.datapoints.id.aggregated.list.get({
  "id": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • id required integer: Id of the datapoint
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • groupBy string (values: week, month): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

datapoints.id.favourite.put

Fast switch the "favourite" field of a datapoint

clickmeter.datapoints.id.favourite.put({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the datapoint

Output

datapoints.id.hits.get

Retrieve the list of events related to this datapoint.

clickmeter.datapoints.id.hits.get({
  "id": 0,
  "timeframe": ""
}, context)

Input

  • input object
    • id required integer: Id of the datapoint
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, custom): Timeframe of the request. See list at $timeframeList
    • limit integer: Limit results to this number
    • offset string: Offset where to start from (it's the lastKey field in the response object)
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • filter string (values: spiders, uniques, nonuniques, conversions): Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")

Output

datapoints.id.notes.put

Fast patch the "notes" field of a datapoint

clickmeter.datapoints.id.notes.put({
  "id": 0,
  "note": {}
}, context)

Input

Output

datapoints.id.reports.get

Retrieve a top report connected to this datapoint

clickmeter.datapoints.id.reports.get({
  "id": 0,
  "type": "",
  "timeframe": ""
}, context)

Input

  • input object
    • id required integer: Id of the datapoint
    • type required string (values: browsers, browsersfamilies, platforms, cities, countries, isps, ips, oss, ossfamilies, keywords, referrers, destinations, languages, params): Type of the report.
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)

Output

domains.get

Retrieve a list of domains

clickmeter.domains.get({}, context)

Input

  • input object
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • type string (values: system, go, personal, dedicated): Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system"
    • name string: Filter domains with this anmen

Output

domains.post

Create a domain

clickmeter.domains.post({
  "value": {}
}, context)

Input

Output

domains.count.get

Retrieve count of domains

clickmeter.domains.count.get({}, context)

Input

  • input object
    • type string (values: system, go, personal, dedicated): Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system"
    • name string: Filter domains with this anmen

Output

domains.id.delete

Delete a domain

clickmeter.domains.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of domain

Output

domains.id.get

Get a domain

clickmeter.domains.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of domain

Output

domains.id.post

Update a domain

clickmeter.domains.id.post({
  "id": 0,
  "value": {}
}, context)

Input

Output

groups.get

List of all the groups associated to the user.

clickmeter.groups.get({}, context)

Input

  • input object
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.
    • status string (values: deleted, active): Status of the group
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude groups created before this date (YYYYMMDD)
    • createdBefore string: Exclude groups created after this date (YYYYMMDD)
    • write boolean: Write permission

Output

groups.post

Create a group

clickmeter.groups.post({
  "value": {}
}, context)

Input

Output

groups.aggregated.get

Retrieve statistics about this customer for a timeframe by groups

clickmeter.groups.aggregated.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • hourly boolean: If using "yesterday" or "today" timeframe you can ask for the hourly detail
    • status string (values: deleted, active): Status of group ("deleted"/"active")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the group is marked as favourite

Output

groups.aggregated.list.get

Retrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity (day/week/month)

clickmeter.groups.aggregated.list.get({
  "timeFrame": ""
}, context)

Input

  • input object
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string: Status of group ("deleted"/"active")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the group is marked as favourite
    • groupBy string (values: deleted, active): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

groups.count.get

Count the groups associated to the user.

clickmeter.groups.count.get({}, context)

Input

  • input object
    • status string (values: deleted, active): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude groups created before this date (YYYYMMDD)
    • createdBefore string: Exclude groups created after this date (YYYYMMDD)
    • write boolean: Write permission

Output

groups.id.delete

Delete group specified by id

clickmeter.groups.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the group

Output

groups.id.get

Get a group

clickmeter.groups.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The id of the group

Output

groups.id.post

Update a group

clickmeter.groups.id.post({
  "id": 0,
  "value": {}
}, context)

Input

Output

groups.id.aggregated.get

Retrieve statistics about this group for a timeframe

clickmeter.groups.id.aggregated.get({
  "id": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • id required integer: Id of the group
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • hourly boolean: If using "yesterday" or "today" timeframe you can ask for the hourly detail

Output

groups.id.aggregated.list.get

Retrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month)

clickmeter.groups.id.aggregated.list.get({
  "id": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • id required integer: Id of the group
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • groupBy string (values: week, month): The temporal entity you want to group by ("week"/"month"). If unspecified is "day".

Output

groups.id.aggregated.summary.get

Retrieve statistics about a subset of datapoints for a timeframe with datapoints data

clickmeter.groups.id.aggregated.summary.get({
  "id": 0,
  "timeFrame": ""
}, context)

Input

  • input object
    • id required integer: Filter by this group id
    • timeFrame required string (values: today, yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, last12months, lastyear, currentyear, beginning, custom): Timeframe of the request. See list at $timeframeList
    • type string (values: tp, tl): Type of datapoint ("tl"/"tp")
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • status string (values: deleted, active): Status of datapoint ("deleted"/"active"/"paused"/"spam")
    • tag string: A comma separated list of tags you want to filter with.
    • favourite boolean: Is the datapoint marked as favourite
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • offset integer: Offset where to start from
    • limit integer: Limit results to this number
    • textSearch string: Filter fields by this pattern

Output

groups.id.datapoints.get

List of all the datapoints associated to the user in this group.

clickmeter.groups.id.datapoints.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the group
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.
    • type string (values: tp, tl): Type of the datapoint ("tp"/"tl")
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • onlyFavorites boolean: Filter fields by favourite status
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

groups.id.datapoints.post

Create a datapoint in this group

clickmeter.groups.id.datapoints.post({
  "id": 0,
  "value": {}
}, context)

Input

Output

groups.id.datapoints.count.get

Count the datapoints associated to the user in this group.

clickmeter.groups.id.datapoints.count.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the group
    • type string (values: tp, tl): Type of the datapoint ("tp"/"tl")
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • onlyFavorites boolean: Filter fields by favourite status
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

groups.id.favourite.put

Fast switch the "favourite" field of a group

clickmeter.groups.id.favourite.put({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the group

Output

groups.id.hits.get

Retrieve the list of events related to this group.

clickmeter.groups.id.hits.get({
  "id": 0,
  "timeframe": ""
}, context)

Input

  • input object
    • id required integer: Id of the group
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, custom): Timeframe of the request. See list at $timeframeList
    • limit integer: Limit results to this number
    • offset string: Offset where to start from (it's the lastKey field in the response object)
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • filter string (values: spiders, uniques, nonuniques, conversions): Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")

Output

groups.id.notes.put

Fast patch the "notes" field of a group

clickmeter.groups.id.notes.put({
  "id": 0,
  "note": {}
}, context)

Input

Output

groups.id.reports.get

Retrieve a top report connected to this group

clickmeter.groups.id.reports.get({
  "id": 0,
  "type": "",
  "timeframe": ""
}, context)

Input

  • input object
    • id required integer: Id of the group
    • type required string (values: browsers, browsersfamilies, platforms, cities, countries, isps, ips, oss, ossfamilies, keywords, referrers, destinations, languages, params): Type of the report.
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, beginning, custom): Timeframe of the request. See list at $timeframeList
    • hittype string (values: clicks, views): Type of the event you want to filter this report with. By default no filter is applied.
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)

Output

hits.get

Retrieve the list of events related to this account.

clickmeter.hits.get({
  "timeframe": ""
}, context)

Input

  • input object
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, custom): Timeframe of the request. See list at $timeframeList
    • limit integer: Limit results to this number
    • offset string: Offset where to start from (it's the lastKey field in the response object)
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)
    • filter string (values: spiders, uniques, nonuniques, conversions): Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")

Output

me.get

Retrieve current account data

clickmeter.me.get(null, context)

Input

This action has no parameters

Output

me.plan.get

Retrieve current account plan

clickmeter.me.plan.get(null, context)

Input

This action has no parameters

Output

reports.get

Retrieve a top report

clickmeter.reports.get({
  "type": "",
  "timeframe": ""
}, context)

Input

  • input object
    • type required string (values: browsers, browsersfamilies, platforms, cities, countries, isps, ips, oss, ossfamilies, keywords, referrers, destinations, languages, params): Type of the report.
    • timeframe required string (values: yesterday, last7, last30, lastmonth, currentmonth, previousmonth, last90, last120, last180, beginning, custom): Timeframe of the request. See list at $timeframeList
    • hittype string: Type of the event you want to filter this report with. By default no filter is applied.
    • group integer: Filter by this group id (mutually exclusive with "datapoint" and "conversion")
    • datapoint integer: Filter by this datapoint id (mutually exclusive with "group" and "conversion")
    • conversion integer: Filter by this conversion id (mutually exclusive with "datapoint" and "group")
    • fromDay string: If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)
    • toDay string: If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)

Output

retargeting.get

List of all the retargeting scripts associated to the user

clickmeter.retargeting.get({}, context)

Input

  • input object
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.

Output

retargeting.post

Creates a retargeting script

clickmeter.retargeting.post({
  "value": {}
}, context)

Input

Output

retargeting.count.get

Retrieve count of retargeting scripts

clickmeter.retargeting.count.get(null, context)

Input

This action has no parameters

Output

retargeting.id.delete

Deletes a retargeting script (and remove associations)

clickmeter.retargeting.id.delete({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The id of the retargeting script

Output

retargeting.id.get

Get a retargeting script object

clickmeter.retargeting.id.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: The id of the retargeting script

Output

retargeting.id.post

Updates a retargeting script

clickmeter.retargeting.id.post({
  "id": 0,
  "value": {}
}, context)

Input

Output

retargeting.id.datapoints.get

List of all the datapoints associated to the retargeting script.

clickmeter.retargeting.id.datapoints.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the retargeting script
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • onlyFavorites boolean: Filter fields by favourite status
    • sortBy string: Field to sort by
    • sortDirection string (values: asc, desc): Direction of sort "asc" or "desc"
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

retargeting.id.datapoints.count.get

Count the datapoints associated to the retargeting script.

clickmeter.retargeting.id.datapoints.count.get({
  "id": 0
}, context)

Input

  • input object
    • id required integer: Id of the group
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • tags string: A comma separated list of tags you want to filter with.
    • textSearch string: Filter fields by this pattern
    • onlyFavorites boolean: Filter fields by favourite status
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

tags.get

List of all the groups associated to the user filtered by this tag.

clickmeter.tags.get({}, context)

Input

  • input object
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.
    • name string: Name of the tag
    • datapoints string: Comma separated list of datapoints id to filter by
    • groups string: Comma separated list of groups id to filter by
    • type string (values: tp, tl, dp, gr): Type of entity related to the tag

Output

tags.post

Create a tag

clickmeter.tags.post({
  "value": {}
}, context)

Input

Output

tags.count.get

List of all the groups associated to the user filtered by this tag.

clickmeter.tags.count.get({}, context)

Input

  • input object
    • name string: Name of the tag
    • datapoints string: Comma separated list of datapoints id to filter by
    • groups string: Comma separated list of groups id to filter by
    • type string (values: tp, tl, dp, gr): Type of entity related to the tag

Output

tags.tagId.delete

Delete a tag

clickmeter.tags.tagId.delete({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: Id of the tag

Output

tags.tagId.get

Retrieve a tag

clickmeter.tags.tagId.get({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: Id of the tag

Output

tags.tagId.datapoints.delete

Delete the association of this tag with all datapoints

clickmeter.tags.tagId.datapoints.delete({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: Id of the tag

Output

tags.tagId.datapoints.get

List of all the datapoints associated to the user filtered by this tag

clickmeter.tags.tagId.datapoints.get({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: Id of the tag.
    • offset integer: Where to start when retrieving elements. Default is 0 if not specified.
    • limit integer: Maximum elements to retrieve. Default to 20 if not specified.
    • type string (values: tp, tl): Type of the datapoint ("tp"/"tl")
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

Output

tags.tagId.datapoints.count.get

Count the datapoints associated to the user filtered by this tag

clickmeter.tags.tagId.datapoints.count.get({
  "tagId": 0
}, context)

Input

  • input object
    • tagId required integer: Id of the tag.
    • type string (values: tp, tl): Type of the datapoint ("tp"/"tl")
    • status string (values: deleted, active, paused, spam): Status of the datapoint
    • textSearch string: Filter fields by this pattern
    • createdAfter string: Exclude datapoints created before this date (YYYYMMDD)
    • createdBefore string: Exclude datapoints created after this date (YYYYMMDD)

datafire
@infinitebrahmanuniverse/nolb-_datafire_c@everything-registry/sub-chunk-221
6.0.0

5 years ago

5.0.0

7 years ago

4.0.0

7 years ago

3.0.0

8 years ago

2.0.3

8 years ago

2.0.2

8 years ago

2.0.1

8 years ago

2.0.0

8 years ago

0.0.3

9 years ago

0.0.1

9 years ago