Client library for ClickMeter
npm install --save @datafire/clickmeter
let clickmeter = require('@datafire/clickmeter').create({
api_key: ""
});
.then(data => {
console.log(data);
});
Api dashboard for ClickMeter API
Retrieve current account data
clickmeter.account.get(null, context)
This action has no parameters
- output Api.Core.Dto.Accounting.User
Update current account data
clickmeter.account.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Accounting.User
- output Api.Core.Dto.Accounting.User
Retrieve list of a domains allowed to redirect in DDU mode
clickmeter.account.domainwhitelist.get({}, context)
- input
object
- offset
integer
: Offset where to start from - limit
integer
: Limit results to this number
- offset
Create an domain entry
clickmeter.account.domainwhitelist.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Accounting.DomainWhitelistEntry
Delete an domain entry
clickmeter.account.domainwhitelist.whitelistId.delete({
"whitelistId": ""
}, context)
- input
object
- whitelistId required
string
: The id of the domain to delete
- whitelistId required
Retrieve list of a guest
clickmeter.account.guests.get({}, context)
- 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
- offset
Create a guest
clickmeter.account.guests.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Accounting.Guest
Retrieve count of guests
clickmeter.account.guests.count.get({}, context)
- input
object
- textSearch
string
: Filter fields by this pattern
- textSearch
Delete a guest
clickmeter.account.guests.guestId.delete({
"guestId": 0
}, context)
- input
object
- guestId required
integer
: Id of the guest
- guestId required
Retrieve a guest
clickmeter.account.guests.guestId.get({
"guestId": 0
}, context)
- input
object
- guestId required
integer
: Id of the guest
- guestId required
Update a guest
clickmeter.account.guests.guestId.post({
"guestId": 0,
"value": {}
}, context)
- input
object
- guestId required
integer
: Id of the guest - value required Api.Core.Dto.Accounting.Guest
- guestId required
Retrieve permissions for a guest
clickmeter.account.guests.guestId.permissions.get({
"guestId": 0
}, context)
- 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
- guestId required
Retrieve count of the permissions for a guest
clickmeter.account.guests.guestId.permissions.count.get({
"guestId": 0
}, context)
- 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
- guestId required
Change the permission on a shared object
clickmeter.account.guests.guestId.type.permissions.patch.post({
"guestId": 0,
"type": "",
"body": {}
}, context)
- input
object
- guestId required
integer
: Id of the guest - type required
string
(values: datapoint, group): Can be "datapoint" or "group" - body required Api.Core.Requests.PermissionPatchRequest
- guestId required
Change the permission on a shared object
clickmeter.account.guests.guestId.type.permissions.patch.put({
"guestId": 0,
"type": "",
"body": {}
}, context)
- input
object
- guestId required
integer
: Id of the guest - type required
string
(values: datapoint, group): Can be "datapoint" or "group" - body required Api.Core.Requests.PermissionPatchRequest
- guestId required
Retrieve list of a ip to exclude from event tracking
clickmeter.account.ipblacklist.get({}, context)
- input
object
- offset
integer
: Offset where to start from - limit
integer
: Limit results to this number
- offset
Create an ip blacklist entry
clickmeter.account.ipblacklist.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Accounting.IpBlacklistEntry
Delete an ip blacklist entry
clickmeter.account.ipblacklist.blacklistId.delete({
"blacklistId": ""
}, context)
- input
object
- blacklistId required
string
: The id of the ip to delete
- blacklistId required
Retrieve current account plan
clickmeter.account.plan.get(null, context)
This action has no parameters
- output Api.Core.Dto.Accounting.Plan
Retrieve statistics about this customer for a timeframe
clickmeter.aggregated.get({
"timeFrame": ""
}, context)
- 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
- timeFrame required
Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month)
clickmeter.aggregated.list.get({
"timeFrame": ""
}, context)
- 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".
- timeFrame required
Retrieve statistics about a subset of conversions for a timeframe with conversions data
clickmeter.aggregated.summary.conversions.get({
"timeFrame": ""
}, context)
- 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
- timeFrame required
Retrieve statistics about a subset of datapoints for a timeframe with datapoints data
clickmeter.aggregated.summary.datapoints.get({
"timeFrame": "",
"type": ""
}, context)
- 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
- timeFrame required
Retrieve statistics about a subset of groups for a timeframe with groups data
clickmeter.aggregated.summary.groups.get({
"timeFrame": ""
}, context)
- 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
- timeFrame required
Retrieve the latest list of events of this account. Limited to last 100.
clickmeter.clickstream.get({}, context)
- 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")
- group
Retrieve a list of conversions
clickmeter.conversions.get({}, context)
- 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)
- offset
Create a conversion
clickmeter.conversions.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Conversions.Conversion
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
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".
- timeFrame required
Retrieve a count of conversions
clickmeter.conversions.count.get({}, context)
- 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)
- status
Delete conversion specified by id
clickmeter.conversions.conversionId.delete({
"conversionId": 0
}, context)
- input
object
- conversionId required
integer
: Id of the conversion
- conversionId required
Retrieve conversion specified by id
clickmeter.conversions.conversionId.get({
"conversionId": 0
}, context)
- input
object
- conversionId required
integer
: Id of the conversion
- conversionId required
Update conversion specified by id
clickmeter.conversions.conversionId.post({
"conversionId": 0,
"value": {}
}, context)
- input
object
- conversionId required
integer
: Id of the conversion - value required Api.Core.Dto.Conversions.Conversion
- conversionId required
Retrieve statistics about this conversion for a timeframe
clickmeter.conversions.conversionId.aggregated.get({
"conversionId": 0,
"timeFrame": ""
}, context)
- 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
- conversionId required
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
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".
- conversionId required
Retrieve a list of datapoints connected to this conversion
clickmeter.conversions.conversionId.datapoints.get({
"conversionId": 0
}, context)
- 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)
- conversionId required
Modify the association between a conversion and multiple datapoints
clickmeter.conversions.conversionId.datapoints.batch.patch.put({
"conversionId": 0,
"data": {}
}, context)
- input
object
- conversionId required
integer
: Id of the conversion - data required Api.Core.Requests.PatchBodyBatch
- conversionId required
Retrieve a count of datapoints connected to this conversion
clickmeter.conversions.conversionId.datapoints.count.get({
"conversionId": 0
}, context)
- 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)
- conversionId required
Modify the association between a conversion and a datapoint
clickmeter.conversions.conversionId.datapoints.patch.put({
"conversionId": 0,
"data": {}
}, context)
- input
object
- conversionId required
integer
: Id of the conversion - data required Api.Core.Requests.ConversionPatchBody
- conversionId required
Retrieve the list of events related to this conversion.
clickmeter.conversions.conversionId.hits.get({
"conversionId": 0,
"timeframe": ""
}, context)
- 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")
- conversionId required
Fast patch the "notes" field of a conversion
clickmeter.conversions.conversionId.notes.put({
"conversionId": 0,
"note": {}
}, context)
- input
object
- conversionId required
integer
: Id of the conversion - note required Api.Core.Requests.GenericTextPatch
- conversionId required
Retrieve a top report connected to this conversion
clickmeter.conversions.conversionId.reports.get({
"conversionId": 0,
"type": "",
"timeframe": ""
}, context)
- 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)
- conversionId required
- output Api.Core.Dto.Tops.Top
List of all the datapoints associated to the user
clickmeter.datapoints.get({}, context)
- 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)
- offset
Create a datapoint
clickmeter.datapoints.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Datapoints.Datapoint
Retrieve statistics about this customer for a timeframe by groups
clickmeter.datapoints.aggregated.get({
"timeFrame": ""
}, context)
- 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
- timeFrame required
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
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".
- type required
Delete multiple datapoints
clickmeter.datapoints.batch.delete({
"batch": {}
}, context)
- input
object
- batch required Api.Core.Requests.DeleteBatch
Update multiple datapoints
clickmeter.datapoints.batch.post({
"batch": {}
}, context)
- input
object
- batch required Api.Core.Requests.DatapointsBatch
Create multiple datapoints
clickmeter.datapoints.batch.put({
"batch": {}
}, context)
- input
object
- batch required Api.Core.Requests.DatapointsBatch
Count the datapoints associated to the user
clickmeter.datapoints.count.get({}, context)
- 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)
- type
Delete a datapoint
clickmeter.datapoints.id.delete({
"id": 0
}, context)
- input
object
- id required
integer
: The id of the datapoint
- id required
Get a datapoint
clickmeter.datapoints.id.get({
"id": 0
}, context)
- input
object
- id required
integer
: The id of the datapoint
- id required
Update a datapoint
clickmeter.datapoints.id.post({
"id": 0,
"value": {}
}, context)
- input
object
- id required
integer
: The id of the datapoint - value required Api.Core.Dto.Datapoints.Datapoint
- id required
Retrieve statistics about this datapoint for a timeframe
clickmeter.datapoints.id.aggregated.get({
"id": 0,
"timeFrame": ""
}, context)
- 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
- id required
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
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".
- id required
Fast switch the "favourite" field of a datapoint
clickmeter.datapoints.id.favourite.put({
"id": 0
}, context)
- input
object
- id required
integer
: Id of the datapoint
- id required
Retrieve the list of events related to this datapoint.
clickmeter.datapoints.id.hits.get({
"id": 0,
"timeframe": ""
}, context)
- 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")
- id required
Fast patch the "notes" field of a datapoint
clickmeter.datapoints.id.notes.put({
"id": 0,
"note": {}
}, context)
- input
object
- id required
integer
: Id of the datapoint - note required Api.Core.Requests.GenericTextPatch
- id required
Retrieve a top report connected to this datapoint
clickmeter.datapoints.id.reports.get({
"id": 0,
"type": "",
"timeframe": ""
}, context)
- 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)
- id required
- output Api.Core.Dto.Tops.Top
Retrieve a list of domains
clickmeter.domains.get({}, context)
- 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
- offset
Create a domain
clickmeter.domains.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Domains.Domain
Retrieve count of domains
clickmeter.domains.count.get({}, context)
- 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
- type
Delete a domain
clickmeter.domains.id.delete({
"id": 0
}, context)
- input
object
- id required
integer
: Id of domain
- id required
Get a domain
clickmeter.domains.id.get({
"id": 0
}, context)
- input
object
- id required
integer
: Id of domain
- id required
- output Api.Core.Dto.Domains.Domain
Update a domain
clickmeter.domains.id.post({
"id": 0,
"value": {}
}, context)
- input
object
- id required
integer
: Id of domain - value required Api.Core.Dto.Domains.Domain
- id required
List of all the groups associated to the user.
clickmeter.groups.get({}, context)
- 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
- offset
Create a group
clickmeter.groups.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Groups.Group
Retrieve statistics about this customer for a timeframe by groups
clickmeter.groups.aggregated.get({
"timeFrame": ""
}, context)
- 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
- timeFrame required
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
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".
- timeFrame required
Count the groups associated to the user.
clickmeter.groups.count.get({}, context)
- 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
- status
Delete group specified by id
clickmeter.groups.id.delete({
"id": 0
}, context)
- input
object
- id required
integer
: Id of the group
- id required
Get a group
clickmeter.groups.id.get({
"id": 0
}, context)
- input
object
- id required
integer
: The id of the group
- id required
- output Api.Core.Dto.Groups.Group
Update a group
clickmeter.groups.id.post({
"id": 0,
"value": {}
}, context)
- input
object
- id required
integer
: The id of the group - value required Api.Core.Dto.Groups.Group
- id required
Retrieve statistics about this group for a timeframe
clickmeter.groups.id.aggregated.get({
"id": 0,
"timeFrame": ""
}, context)
- 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
- id required
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
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".
- id required
Retrieve statistics about a subset of datapoints for a timeframe with datapoints data
clickmeter.groups.id.aggregated.summary.get({
"id": 0,
"timeFrame": ""
}, context)
- 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
- id required
List of all the datapoints associated to the user in this group.
clickmeter.groups.id.datapoints.get({
"id": 0
}, context)
- 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)
- id required
Create a datapoint in this group
clickmeter.groups.id.datapoints.post({
"id": 0,
"value": {}
}, context)
- input
object
- id required
integer
: The id of the group - value required Api.Core.Dto.Datapoints.Datapoint
- id required
Count the datapoints associated to the user in this group.
clickmeter.groups.id.datapoints.count.get({
"id": 0
}, context)
- 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)
- id required
Fast switch the "favourite" field of a group
clickmeter.groups.id.favourite.put({
"id": 0
}, context)
- input
object
- id required
integer
: Id of the group
- id required
Retrieve the list of events related to this group.
clickmeter.groups.id.hits.get({
"id": 0,
"timeframe": ""
}, context)
- 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")
- id required
Fast patch the "notes" field of a group
clickmeter.groups.id.notes.put({
"id": 0,
"note": {}
}, context)
- input
object
- id required
integer
: Id of the group - note required Api.Core.Requests.GenericTextPatch
- id required
Retrieve a top report connected to this group
clickmeter.groups.id.reports.get({
"id": 0,
"type": "",
"timeframe": ""
}, context)
- 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)
- id required
- output Api.Core.Dto.Tops.Top
Retrieve the list of events related to this account.
clickmeter.hits.get({
"timeframe": ""
}, context)
- 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")
- timeframe required
Retrieve current account data
clickmeter.me.get(null, context)
This action has no parameters
- output Api.Core.Dto.Accounting.User
Retrieve current account plan
clickmeter.me.plan.get(null, context)
This action has no parameters
- output Api.Core.Dto.Accounting.Plan
Retrieve a top report
clickmeter.reports.get({
"type": "",
"timeframe": ""
}, context)
- 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)
- type required
- output Api.Core.Dto.Tops.Top
List of all the retargeting scripts associated to the user
clickmeter.retargeting.get({}, context)
- 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.
- offset
Creates a retargeting script
clickmeter.retargeting.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Retargeting.RetargetingScript
Retrieve count of retargeting scripts
clickmeter.retargeting.count.get(null, context)
This action has no parameters
Deletes a retargeting script (and remove associations)
clickmeter.retargeting.id.delete({
"id": 0
}, context)
- input
object
- id required
integer
: The id of the retargeting script
- id required
Get a retargeting script object
clickmeter.retargeting.id.get({
"id": 0
}, context)
- input
object
- id required
integer
: The id of the retargeting script
- id required
Updates a retargeting script
clickmeter.retargeting.id.post({
"id": 0,
"value": {}
}, context)
- input
object
- id required
integer
: The id of the retargeting script - value required Api.Core.Dto.Retargeting.RetargetingScript
- id required
List of all the datapoints associated to the retargeting script.
clickmeter.retargeting.id.datapoints.get({
"id": 0
}, context)
- 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)
- id required
Count the datapoints associated to the retargeting script.
clickmeter.retargeting.id.datapoints.count.get({
"id": 0
}, context)
- 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)
- id required
List of all the groups associated to the user filtered by this tag.
clickmeter.tags.get({}, context)
- 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
- offset
Create a tag
clickmeter.tags.post({
"value": {}
}, context)
- input
object
- value required Api.Core.Dto.Tags.Tag
List of all the groups associated to the user filtered by this tag.
clickmeter.tags.count.get({}, context)
- 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
- name
- output System.Object
Delete a tag
clickmeter.tags.tagId.delete({
"tagId": 0
}, context)
- input
object
- tagId required
integer
: Id of the tag
- tagId required
- output System.Object
Retrieve a tag
clickmeter.tags.tagId.get({
"tagId": 0
}, context)
- input
object
- tagId required
integer
: Id of the tag
- tagId required
- output Api.Core.Dto.Tags.Tag
Delete the association of this tag with all datapoints
clickmeter.tags.tagId.datapoints.delete({
"tagId": 0
}, context)
- input
object
- tagId required
integer
: Id of the tag
- tagId required
List of all the datapoints associated to the user filtered by this tag
clickmeter.tags.tagId.datapoints.get({
"tagId": 0
}, context)
- 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)
- tagId required
Count the datapoints associated to the user filtered by this tag
clickmeter.tags.tagId.datapoints.count.get({
"tagId": 0
}, context)
- 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)
- tagId required
Associate/Deassociate a tag with a datapoint
clickmeter.tags.tagId.datapoints.patch.put({
"tagId": 0,
"data": {}
}, context)
- input
object
- tagId required
integer
: Id of the tag - data required Api.Core.Requests.PatchBody
- tagId required
Delete the association of this tag with all groups
clickmeter.tags.tagId.groups.delete({
"tagId": 0
}, context)
- input
object
- tagId required
integer
: Id of the tag
- tagId required
List of all the groups associated to the user filtered by this tag.
clickmeter.tags.tagId.groups.get({
"tagId": 0
}, context)
- 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. - status
string
(values: deleted, active): Status of the datapoint - 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)
- tagId required
Count the groups associated to the user filtered by this tag
clickmeter.tags.tagId.groups.count.get({
"tagId": 0
}, context)
- input
object
- tagId required
integer
: Id of the tag. - status
string
(values: deleted, active): Status of the datapoint - 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)
- tagId required
Associate/Deassociate a tag with a group
clickmeter.tags.tagId.groups.patch.put({
"tagId": 0,
"data": {}
}, context)
- input
object
- tagId required
integer
: Id of the tag - data required Api.Core.Requests.PatchBody
- tagId required
Fast patch a tag name
clickmeter.tags.tagId.name.put({
"tagId": 0,
"data": {}
}, context)
- input
object
- tagId required
integer
: Id of the tag - data required Api.Core.Requests.GenericTextPatch
- tagId required
- Api.Core.Dto.Accounting.ConversionOptions
object
- hideComCost
boolean
- hideCost
boolean
- hideCount
boolean
- hideParams
boolean
- hideValue
boolean
- percentCommission
integer
- percentValue
integer
- hideComCost
- Api.Core.Dto.Accounting.DomainWhitelistEntry
object
- id
string
- name
string
- id
- Api.Core.Dto.Accounting.ExtendedGrants
object
- allowAllGrants
boolean
- allowGroupCreation
boolean
- allowAllGrants
- Api.Core.Dto.Accounting.Guest
object
- apiKey
string
- conversionOptions Api.Core.Dto.Accounting.ConversionOptions
- creationDate
string
: (A date in "YmdHis" format) - currentGrant Api.Core.Dto.Grants.Grant
- dateFormat
string
- decimalSeparator
string
- email
string
- extendedGrants Api.Core.Dto.Accounting.ExtendedGrants
- groupGrants
integer
- hitOptions Api.Core.Dto.Accounting.HitOptions
- id
integer
- key
string
- language
string
- loginCount
integer
- name
string
- notes
string
- numberGroupSeparator
string
- password
string
- timeFormat
string
(values: AmPm, H24) - timeZone
integer
- timeframeMinDate
string
: (A date in "YmdHis" format) - timezonename
string
- tlGrants
integer
- tpGrants
integer
- userName
string
- apiKey
- Api.Core.Dto.Accounting.HitOptions
object
- hideReferrer
boolean
- hideReferrer
- Api.Core.Dto.Accounting.IpBlacklistEntry
object
- id
string
- ip
string
- id
- Api.Core.Dto.Accounting.Plan
object
- allowedPersonalDomains
integer
- allowedPersonalUrls
integer
- billingPeriodEnd
string
: (A date in "YmdHis" format) - billingPeriodStart
string
: (A date in "YmdHis" format) - bonusMonthlyEvents
integer
- maximumDatapoints
integer
- maximumGuests
integer
- monthlyEvents
integer
- name
string
- price
number
- profileId
integer
- recurring
boolean
- recurringPeriod
integer
- usedDatapoints
integer
- usedMonthlyEvents
integer
- allowedPersonalDomains
- Api.Core.Dto.Accounting.User
object
- boGoVal
string
- bonusClicks
integer
- companyName
string
- companyRole
string
- email
string
- firstName
string
- lastName
string
- phone
string
- redirectOnly
boolean
- registrationDate
string
: (A date in "YmdHis" format) - timeframeMinDate
string
: (A date in "YmdHis" format) - timezone
integer
- timezonename
string
- boGoVal
- Api.Core.Dto.Aggregated.AggregatedResult
object
- activityDay
string
: (A date in "YmdHis" format) - commissionsCost
number
- conversionsCost
number
- conversionsValue
number
- convertedClicks
integer
- entityData System.Object
- entityId
string
- fromDay
string
: (A date in "YmdHis" format) - hourlyBreakDown
object
- lastHitDate
string
: (A date in "YmdHis" format) - spiderHitsCount
integer
- toDay
string
: (A date in "YmdHis" format) - totalClicks
integer
- totalViews
integer
- uniqueClicks
integer
- uniqueConversions
integer
- uniqueViews
integer
- activityDay
- Api.Core.Dto.Aggregated.AggregatedSummaryResult
object
- count
integer
- limit
integer
- offset
integer
- result
array
- count
- Api.Core.Dto.ClickStream.Hit
object
- accessTime
string
: (A date in "YmdHis" format) - browser Api.Core.Dto.ClickStream.HitBrowserInfo
- clientLanguage
string
- conversion1 Api.Core.Dto.ClickStream.HitConversionInfo
- conversion2 Api.Core.Dto.ClickStream.HitConversionInfo
- conversion3 Api.Core.Dto.ClickStream.HitConversionInfo
- conversion4 Api.Core.Dto.ClickStream.HitConversionInfo
- conversion5 Api.Core.Dto.ClickStream.HitConversionInfo
- conversions
array
- entity Api.Core.Dto.ClickStream.HitDatapointInfo
- ip
string
- isProxy
string
- isSpider
string
- isUnique
string
- location Api.Core.Dto.ClickStream.HitLocationInfo
- org
string
- os Api.Core.Dto.ClickStream.HitOsInfo
- queryParams
string
- realDestinationUrl
string
- referer
string
- source Api.Core.Dto.ClickStream.HitSource
- type
string
- accessTime
- Api.Core.Dto.ClickStream.HitBrowserInfo
object
- browserType
string
- familyId
integer
- familyName
string
- id
integer
- name
string
- browserType
- Api.Core.Dto.ClickStream.HitConversionInfo
object
- accessTime
string
: (A date in "YmdHis" format) - comcost
number
- cost
number
- date
string
: (A date in "YmdHis" format) - deleted
boolean
- id
integer
- name
string
- parameter
string
- value
number
- accessTime
- Api.Core.Dto.ClickStream.HitDatapointInfo
object
- creationDate
string
: (A date in "YmdHis" format) - datapointFavourite
boolean
- datapointId
integer
- datapointName
string
- datapointTitle
string
- datapointType
string
- destinationUrl
string
- groupId
integer
- groupName
string
- isABTest
boolean
- isPrivateShared
boolean
- isPublic
boolean
- notes
string
- status
string
(values: Active, Paused, Abuse, Deleted) - tags
array
- items Api.Core.Dto.Tags.Tag
- trackingCode
string
- creationDate
- Api.Core.Dto.ClickStream.HitListPage
object
- hits
array
- lastKey
string
- hits
- Api.Core.Dto.ClickStream.HitLocationInfo
object
- areacode
string
- city
string
- country
string
- latitude
number
- longitude
number
- metrocode
string
- organization
string
- postalcode
string
- region
string
- regionName
string
- areacode
- Api.Core.Dto.ClickStream.HitOsInfo
object
- familyId
integer
- familyName
string
- id
integer
- name
string
- familyId
- Api.Core.Dto.ClickStream.HitSource
object
- id
integer
- name
string
- param
string
- id
- Api.Core.Dto.Conversions.Conversion
object
- code
string
- creationDate
string
: (A date in "YmdHis" format) - deleted
boolean
- description
string
- id
integer
- name
string
- protocol
string
(values: Http, Https) - value
number
- code
- Api.Core.Dto.Datapoints.BrowserBaseDestinationItem
object
- emailDestinationUrl
string
- mobileDestinationUrl
string
- spidersDestinationUrl
string
- emailDestinationUrl
- Api.Core.Dto.Datapoints.Datapoint
object
- creationDate
string
: (A date in "YmdHis" format) - encodeIp
boolean
- fifthConversionId
integer
- fifthConversionName
string
- firstConversionId
integer
- firstConversionName
string
- fourthConversionId
integer
- fourthConversionName
string
- groupId
integer
- groupName
string
- id
integer
- isPublic
boolean
- isSecured
boolean
- lightTracking
boolean
- name
string
- notes
string
- preferred
boolean
- redirectOnly
boolean
- secondConversionId
integer
- secondConversionName
string
- status
string
(values: Active, Paused, Abuse, Deleted) - tags
array
- items Api.Core.Dto.Tags.Tag
- thirdConversionId
integer
- thirdConversionName
string
- title
string
- trackingCode
string
- type
string
(values: TrackingLink, TrackingPixel) - typeTL Api.Core.Dto.Datapoints.TrackingLinkSpecifics
- typeTP Api.Core.Dto.Datapoints.TrackingPixelSpecifics
- writePermited
boolean
- creationDate
- Api.Core.Dto.Datapoints.DatapointRetargetingInfo
object
- id
integer
- name
string
- id
- Api.Core.Dto.Datapoints.MultipleDestinationItem
object
- url
string
- url
- Api.Core.Dto.Datapoints.TrackingLinkSpecifics
object
- appendQuery
boolean
- browserDestinationItem Api.Core.Dto.Datapoints.BrowserBaseDestinationItem
- destinationMode
string
(values: Simple, RandomDestination, DestinationByLanguage, SpilloverDestination, DynamicUrl, BrowserDestination, DestinationByNation, UniqueDestination, SequentialDestination, WeightedDestination) - domainId
integer
- encodeUrl
boolean
- expirationClicks
integer
- expirationDate
string
: (A date in "YmdHis" format) - firstUrl
string
- goDomainId
integer
- hideUrl
boolean
- hideUrlTitle
string
- isABTest
boolean
- password
string
- pauseAfterClicksExpiration
boolean
- pauseAfterDateExpiration
boolean
- randomDestinationItems
array
- redirectType
string
(values: PermanentRedirect, TemporaryRedirect) - referrerClean
string
(values: None, Clean, Myself) - scripts
array
- sequentialDestinationItems
array
- spilloverDestinationItems
array
- uniqueDestinationItem Api.Core.Dto.Datapoints.UniqueDestinationItem
- url
string
- urlAfterClicksExpiration
string
- urlAfterDateExpiration
string
- urlsByLanguage
array
- urlsByNation
array
- weightedDestinationItems
array
- appendQuery
- Api.Core.Dto.Datapoints.TrackingPixelSpecifics
object
- parameterNote
string
- parameterNote
- Api.Core.Dto.Datapoints.UniqueDestinationItem
object
- firstDestinationUrl
string
- firstDestinationUrl
- Api.Core.Dto.Datapoints.UrlByLanguageItem
object
- languageCode
string
- url
string
- languageCode
- Api.Core.Dto.Datapoints.UrlByNationItem
object
- nation
string
- url
string
- nation
- Api.Core.Dto.Datapoints.WeightedDestinationItem
object
- url
string
- weight
integer
- url
- Api.Core.Dto.Domains.Domain
object
- custom404
string
- customHomepage
string
- id
integer
- name
string
- type
string
(values: System, Go, Dedicated, Personal)
- custom404
- Api.Core.Dto.EntityUriLong
object
- id
integer
- uri
string
- id
- Api.Core.Dto.Grants.Grant
object
- DatapointType
string
- Entity Api.Core.Responses.EntityUri[System.Int64]
- EntityName
string
- EntityType
string
- Type
string
- DatapointType
- Api.Core.Dto.Groups.Group
object
- creationDate
string
: (A date in "YmdHis" format) - deleted
boolean
- id
integer
- isPublic
boolean
- name
string
- notes
string
- preferred
boolean
- redirectOnly
boolean
- tags
array
- items Api.Core.Dto.Tags.Tag
- writePermited
boolean
- creationDate
- Api.Core.Dto.Retargeting.RetargetingScript
object
- id
integer
- name
string
- script
string
- id
- Api.Core.Dto.Tags.Tag
object
- datapoints
array
- items
integer
- items
- groups
array
- items
integer
- items
- id
integer
- name
string
- datapoints
- Api.Core.Dto.Tops.Top
object
- createdAt
string
: (A date in "YmdHis" format) - data
array
- key
string
- createdAt
- Api.Core.Dto.Tops.TopItem
object
- entityData System.Object
- id
string
- lastHitDate
string
: (A date in "YmdHis" format) - spiderClicks
integer
- spiderHits
integer
- spiderViews
integer
- totalClicks
integer
- totalCommissionsCost
number
- totalConversions
integer
- totalConversionsCost
number
- totalConversionsValue
number
- totalHits
integer
- totalViews
integer
- uniqueClicks
integer
- uniqueHits
integer
- uniqueViews
integer
- Api.Core.Requests.ConversionPatchBody
object
- Action
string
- Id
integer
- ReplaceId
integer
- Action
- Api.Core.Requests.DatapointsBatch
object
- List
array
- List
- Api.Core.Requests.DeleteBatch
object
- Entities
array
- Entities
- Api.Core.Requests.GenericTextPatch
object
- Text
string
- Text
- Api.Core.Requests.PatchBody
object
- Action
string
- Id
integer
- Action
- Api.Core.Requests.PatchBodyBatch
object
- PatchRequests
array
- PatchRequests
- Api.Core.Requests.PermissionPatchRequest
object
- Action
string
- Id
integer
- Verb
string
- Action
- Api.Core.Responses.CountResponce
object
- count
integer
- count
- Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.DomainWhitelistEntry]
object
- entities
array
- entities
- Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.IpBlacklistEntry]
object
- entities
array
- entities
- Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]
object
- entities
array
- entities
- Api.Core.Responses.EntitiesResponse[Api.Core.Dto.ClickStream.Hit]
object
- entities
array
- entities
- Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Grants.Grant]
object
- entities
array
- entities
- Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]
object
- entities
array
- entities
- Api.Core.Responses.EntityUri[System.Int64]
object
- id
integer
- uri
string
- id
- Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]
object
- entityData Api.Core.Dto.Datapoints.Datapoint
- errors
array
- result Api.Core.Responses.EntityUri[System.Int64]
- status
string
- ClickMeter.Infrastructure.Validation.ValidationFailure
object
- code System.Object
- errorMessage
string
- errorValue System.Object
- property
string
- System.Object
object