swagger: '2.0' schemes: - http - https host: 'apiv2.clickmeter.com:80' info: contact: email: api@clickmeter.com name: Api Support url: 'http://www.clickmeter.com/api' description: Api dashboard for ClickMeter API title: ClickMeter version: v2 x-logo: url: 'https://s3.amazonaws.com/clickmeter.com/Web/static/cmlogo.svg' x-origin: format: swagger url: 'http://api.v2.clickmeter.com.s3.amazonaws.com/docs/api-docs-v2.json' version: '2.0' x-providerName: clickmeter.com securityDefinitions: api_key: description: API Key Authentication in: header name: X-Clickmeter-AuthKey type: apiKey security: - api_key: [] paths: /account: get: consumes: [] deprecated: false produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.User' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve current account data tags: - Account post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Accounting.User' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.User' '401': description: Unauthorized '500': description: Internal Server Error summary: Update current account data tags: - Account /account/domainwhitelist: get: consumes: [] deprecated: false parameters: - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.DomainWhitelistEntry]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve list of a domains allowed to redirect in DDU mode tags: - Account post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: The entry to add in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' '401': description: Unauthorized '500': description: Internal Server Error summary: Create an domain entry tags: - Account '/account/domainwhitelist/{whitelistId}': delete: consumes: [] deprecated: false parameters: - description: The id of the domain to delete in: path name: whitelistId required: true type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete an domain entry tags: - Account /account/guests: get: consumes: [] deprecated: false parameters: - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve list of a guest tags: - Account post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Guest object to create in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' '401': description: Unauthorized '500': description: Internal Server Error summary: Create a guest tags: - Account /account/guests/count: get: consumes: [] deprecated: false parameters: - description: Filter fields by this pattern in: query name: textSearch required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve count of guests tags: - Account '/account/guests/{guestId}': delete: consumes: [] deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete a guest tags: - Account get: consumes: [] deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a guest tags: - Account post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer - description: Guest object with field updated in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Guest' '401': description: Unauthorized '500': description: Internal Server Error summary: Update a guest tags: - Account '/account/guests/{guestId}/permissions': get: consumes: [] deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer - description: 'Can be "datapoint" or "group"' enum: - datapoint - group in: query name: entityType required: false type: string - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: 'Can be "w" or "r"' enum: - r - w in: query name: type required: false type: string - description: Optional id of the datapoint/group entity to filter by format: int64 in: query name: entityId required: false type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Grants.Grant]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve permissions for a guest tags: - Account '/account/guests/{guestId}/permissions/count': get: consumes: [] deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer - description: 'Can be "datapoint" or "group"' enum: - datapoint - group in: query name: entityType required: false type: string - description: 'Can be "w" or "r"' enum: - r - w in: query name: type required: false type: string - description: Optional id of the datapoint/group entity to filter by format: int64 in: query name: entityId required: false type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve count of the permissions for a guest tags: - Account '/account/guests/{guestId}/{type}/permissions/patch': post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer - description: 'Can be "datapoint" or "group"' enum: - datapoint - group in: path name: type required: true type: string - description: The patch permission request in: body name: body required: true schema: $ref: '#/definitions/Api.Core.Requests.PermissionPatchRequest' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Change the permission on a shared object tags: - Account put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the guest format: int64 in: path name: guestId required: true type: integer - description: 'Can be "datapoint" or "group"' enum: - datapoint - group in: path name: type required: true type: string - description: The patch permission request in: body name: body required: true schema: $ref: '#/definitions/Api.Core.Requests.PermissionPatchRequest' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Change the permission on a shared object tags: - Account /account/ipblacklist: get: consumes: [] deprecated: false parameters: - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.IpBlacklistEntry]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve list of a ip to exclude from event tracking tags: - Account post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: The entry to add in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' '401': description: Unauthorized '500': description: Internal Server Error summary: Create an ip blacklist entry tags: - Account '/account/ipblacklist/{blacklistId}': delete: consumes: [] deprecated: false parameters: - description: The id of the ip to delete in: path name: blacklistId required: true type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete an ip blacklist entry tags: - Account /account/plan: get: consumes: [] deprecated: false produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Plan' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve current account plan tags: - Account /aggregated: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' in: query name: hourly required: false type: boolean - description: '' in: query name: onlyFavorites required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this customer for a timeframe tags: - Aggregated /aggregated/list: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - week - month in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month) tags: - Aggregated /aggregated/summary/conversions: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of conversion ("deleted"/"active")' enum: - deleted - active in: query name: status required: false type: string - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Filter fields by this pattern in: query name: textSearch required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about a subset of conversions for a timeframe with conversions data tags: - Aggregated /aggregated/summary/datapoints: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'Type of datapoint ("tl"/"tp")' enum: - tp - tl in: query name: type required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the datapoint marked as favourite in: query name: favourite required: false type: boolean - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Filter by this group id format: int64 in: query name: groupId required: false type: integer - description: Filter fields by this pattern in: query name: textSearch required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about a subset of datapoints for a timeframe with datapoints data tags: - Aggregated /aggregated/summary/groups: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of group ("deleted"/"active")' enum: - deleted - active in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the group marked as favourite in: query name: favourite required: false type: boolean - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Filter fields by this pattern in: query name: textSearch required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about a subset of groups for a timeframe with groups data tags: - Aggregated /clickstream: get: consumes: [] deprecated: false parameters: - description: 'Filter by this group id (mutually exclusive with "datapoint" and "conversion")' format: int64 in: query name: group required: false type: integer - description: 'Filter by this datapoint id (mutually exclusive with "group" and "conversion")' format: int64 in: query name: datapoint required: false type: integer - description: 'Filter by this conversion id (mutually exclusive with "datapoint" and "group")' format: int64 in: query name: conversion required: false type: integer - default: 50 description: Limit results to this number format: int32 in: query name: pageSize required: false type: integer - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' enum: - '' - spiders - uniques - nonuniques - conversions in: query name: filter required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.ClickStream.Hit]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve the latest list of events of this account. Limited to last 100. tags: - ClickStream /conversions: get: consumes: [] deprecated: false parameters: - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: 'Status of conversion ("deleted"/"active")' enum: - deleted - active in: query name: status required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude conversions created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude conversions created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a list of conversions tags: - Conversions post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: The body of the conversion in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Conversions.Conversion' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Create a conversion tags: - Conversions /conversions/aggregated/list: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of conversion ("deleted"/"active")' enum: - deleted - active in: query name: status required: false type: string - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - week - month in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some temporal entity (day/week/month) tags: - Conversions /conversions/count: get: consumes: [] deprecated: false parameters: - description: 'Status of conversion ("deleted"/"active")' enum: - deleted - active in: query name: status required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude conversions created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude conversions created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a count of conversions tags: - Conversions '/conversions/{conversionId}': delete: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Delete conversion specified by id tags: - Conversions get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Conversions.Conversion' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Retrieve conversion specified by id tags: - Conversions post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Updated body of the conversion in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Conversions.Conversion' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Update conversion specified by id tags: - Conversions '/conversions/{conversionId}/aggregated': get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: Filter by this tag name in: query name: tag required: false type: string - description: Is the datapoint marked as favourite in: query name: favourite required: false type: boolean - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' in: query name: hourly required: false type: boolean produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this conversion for a timeframe tags: - Conversions '/conversions/{conversionId}/aggregated/list': get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - week - month in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month) tags: - Conversions '/conversions/{conversionId}/datapoints': get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: 'Type of datapoint ("tl"/"tp")' enum: - tp - tl in: query name: type required: false type: string - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: Filter by this tag name in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a list of datapoints connected to this conversion tags: - Conversions '/conversions/{conversionId}/datapoints/batch/patch': put: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Patch requests in: body name: data required: true schema: $ref: '#/definitions/Api.Core.Requests.PatchBodyBatch' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Modify the association between a conversion and multiple datapoints tags: - Conversions '/conversions/{conversionId}/datapoints/count': get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: 'Type of datapoint ("tl"/"tp")' in: query name: type required: false type: string - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' in: query name: status required: false type: string - description: Filter by this tag name in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a count of datapoints connected to this conversion tags: - Conversions '/conversions/{conversionId}/datapoints/patch': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Patch request in: body name: data required: true schema: $ref: '#/definitions/Api.Core.Requests.ConversionPatchBody' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Modify the association between a conversion and a datapoint tags: - Conversions '/conversions/{conversionId}/hits': get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - custom in: query name: timeframe required: true type: string - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: "Offset where to start from (it's the lastKey field in the response object)" in: query name: offset required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' enum: - spiders - uniques - nonuniques - conversions in: query name: filter required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve the list of events related to this conversion. tags: - Conversions '/conversions/{conversionId}/notes': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Patch requests in: body name: note required: true schema: $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '403': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: 'Fast patch the "notes" field of a conversion' tags: - Conversions '/conversions/{conversionId}/reports': get: consumes: [] deprecated: false parameters: - description: Id of the conversion format: int64 in: path name: conversionId required: true type: integer - description: Type of the report. enum: - datapoints - groups - browsers - browsersfamilies - platforms - cities - countries - keywords - referrers - convparameters - destinations - languages - params in: query name: type required: true type: string - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - beginning - custom in: query name: timeframe required: true type: string - description: Type of the event you want to filter this report with. By default no filter is applied. enum: - clicks - views in: query name: hittype required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Tops.Top' '401': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: Retrieve a top report connected to this conversion tags: - Conversions /datapoints: get: consumes: [] deprecated: false parameters: - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: 'Type of the datapoint ("tp"/"tl")' enum: - tp - tl in: query name: type required: false type: string - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Filter fields by favourite status in: query name: onlyFavorites required: false type: boolean - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the datapoints associated to the user tags: - DataPoints post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: The body of the datapoint in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Create a datapoint tags: - DataPoints /datapoints/aggregated: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'Type of datapoint ("tl"/"tp")' enum: - tp - tl in: query name: type required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' in: query name: hourly required: false type: boolean - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the datapoint is marked as favourite in: query name: favourite required: false type: boolean produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this customer for a timeframe by groups tags: - DataPoints /datapoints/aggregated/list: get: consumes: [] deprecated: false parameters: - description: 'Type of datapoint ("tl"/"tp")' enum: - tp - tl in: query name: type required: true type: string - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the datapoint is marked as favourite in: query name: favourite required: false type: boolean - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - week - month in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity (day/week/month) tags: - DataPoints /datapoints/batch: delete: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: A json containing the datapoints to delete. in: body name: batch required: true schema: $ref: '#/definitions/Api.Core.Requests.DeleteBatch' produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Delete multiple datapoints tags: - DataPoints post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: A json containing the datapoints to update. in: body name: batch required: true schema: $ref: '#/definitions/Api.Core.Requests.DatapointsBatch' produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Update multiple datapoints tags: - DataPoints put: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: A json containing the datapoints to create. in: body name: batch required: true schema: $ref: '#/definitions/Api.Core.Requests.DatapointsBatch' produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Create multiple datapoints tags: - DataPoints /datapoints/count: get: consumes: [] deprecated: false parameters: - description: 'Type of the datapoint ("tp"/"tl")' enum: - tp - tl in: query name: type required: false type: string - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Filter fields by favourite status in: query name: onlyFavorites required: false type: boolean - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Count the datapoints associated to the user tags: - DataPoints '/datapoints/{id}': delete: consumes: [] deprecated: false parameters: - description: The id of the datapoint format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Delete a datapoint tags: - DataPoints get: consumes: [] deprecated: false parameters: - description: The id of the datapoint format: int64 in: path name: id required: true type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Get a datapoint tags: - DataPoints post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: The id of the datapoint format: int64 in: path name: id required: true type: integer - description: The body of the datapoint in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Update a datapoint tags: - DataPoints '/datapoints/{id}/aggregated': get: consumes: [] deprecated: false parameters: - description: Id of the datapoint format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' in: query name: hourly required: false type: boolean produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this datapoint for a timeframe tags: - DataPoints '/datapoints/{id}/aggregated/list': get: consumes: [] deprecated: false parameters: - description: Id of the datapoint format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - week - month in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month) tags: - DataPoints '/datapoints/{id}/favourite': put: consumes: [] deprecated: false parameters: - description: Id of the datapoint format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '403': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: 'Fast switch the "favourite" field of a datapoint' tags: - DataPoints '/datapoints/{id}/hits': get: consumes: [] deprecated: false parameters: - description: Id of the datapoint format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - custom in: query name: timeframe required: true type: string - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: "Offset where to start from (it's the lastKey field in the response object)" in: query name: offset required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' enum: - spiders - uniques - nonuniques - conversions in: query name: filter required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve the list of events related to this datapoint. tags: - DataPoints '/datapoints/{id}/notes': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the datapoint format: int64 in: path name: id required: true type: integer - description: Patch requests in: body name: note required: true schema: $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '403': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: 'Fast patch the "notes" field of a datapoint' tags: - DataPoints '/datapoints/{id}/reports': get: consumes: [] deprecated: false parameters: - description: Id of the datapoint format: int64 in: path name: id required: true type: integer - description: Type of the report. enum: - browsers - browsersfamilies - platforms - cities - countries - isps - ips - oss - ossfamilies - keywords - referrers - destinations - languages - params in: query name: type required: true type: string - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - beginning - custom in: query name: timeframe required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Tops.Top' '401': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: Retrieve a top report connected to this datapoint tags: - DataPoints /domains: get: consumes: [] deprecated: false parameters: - description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - default: system description: 'Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system"' enum: - system - go - personal - dedicated in: query name: type required: false type: string - description: Filter domains with this anmen in: query name: name required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a list of domains tags: - Domains post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: The domain to create in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Domains.Domain' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Create a domain tags: - Domains /domains/count: get: consumes: [] deprecated: false parameters: - default: system description: 'Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system"' enum: - system - go - personal - dedicated in: query name: type required: false type: string - description: Filter domains with this anmen in: query name: name required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve count of domains tags: - Domains '/domains/{id}': delete: consumes: [] deprecated: false parameters: - description: Id of domain format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete a domain tags: - Domains get: consumes: [] deprecated: false parameters: - description: Id of domain format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Domains.Domain' '401': description: Unauthorized '500': description: Internal Server Error summary: Get a domain tags: - Domains post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of domain format: int64 in: path name: id required: true type: integer - description: The domain to update in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Domains.Domain' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Update a domain tags: - Domains /groups: get: consumes: [] deprecated: false parameters: - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Status of the group enum: - deleted - active in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude groups created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude groups created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string - description: Write permission in: query name: write required: false type: boolean produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the groups associated to the user. tags: - Groups post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: The body of the group in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Groups.Group' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Create a group tags: - Groups /groups/aggregated: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' in: query name: hourly required: false type: boolean - description: 'Status of group ("deleted"/"active")' enum: - deleted - active in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the group is marked as favourite in: query name: favourite required: false type: boolean produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this customer for a timeframe by groups tags: - Groups /groups/aggregated/list: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of group ("deleted"/"active")' in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the group is marked as favourite in: query name: favourite required: false type: boolean - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - deleted - active in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity (day/week/month) tags: - Groups /groups/count: get: consumes: [] deprecated: false parameters: - description: Status of the datapoint enum: - deleted - active in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude groups created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude groups created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string - description: Write permission in: query name: write required: false type: boolean produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Count the groups associated to the user. tags: - Groups '/groups/{id}': delete: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Delete group specified by id tags: - Groups get: consumes: [] deprecated: false parameters: - description: The id of the group format: int64 in: path name: id required: true type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Groups.Group' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Get a group tags: - Groups post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: The id of the group format: int64 in: path name: id required: true type: integer - description: The body of the group in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Groups.Group' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Update a group tags: - Groups '/groups/{id}/aggregated': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'If using "yesterday" or "today" timeframe you can ask for the hourly detail' in: query name: hourly required: false type: boolean produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this group for a timeframe tags: - Groups '/groups/{id}/aggregated/list': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'The temporal entity you want to group by ("week"/"month"). If unspecified is "day".' enum: - week - month in: query name: groupBy required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month) tags: - Groups '/groups/{id}/aggregated/summary': get: consumes: [] deprecated: false parameters: - description: Filter by this group id format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - today - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - last12months - lastyear - currentyear - beginning - custom in: query name: timeFrame required: true type: string - description: 'Type of datapoint ("tl"/"tp")' enum: - tp - tl in: query name: type required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Status of datapoint ("deleted"/"active"/"paused"/"spam")' enum: - deleted - active in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tag required: false type: string - description: Is the datapoint marked as favourite in: query name: favourite required: false type: boolean - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - default: 0 description: Offset where to start from format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Filter fields by this pattern in: query name: textSearch required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedSummaryResult' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve statistics about a subset of datapoints for a timeframe with datapoints data tags: - Groups '/groups/{id}/datapoints': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: 'Type of the datapoint ("tp"/"tl")' enum: - tp - tl in: query name: type required: false type: string - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Filter fields by favourite status in: query name: onlyFavorites required: false type: boolean - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the datapoints associated to the user in this group. tags: - Groups post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: The id of the group format: int64 in: path name: id required: true type: integer - description: The body of the datapoint in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Create a datapoint in this group tags: - Groups '/groups/{id}/datapoints/count': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: 'Type of the datapoint ("tp"/"tl")' enum: - tp - tl in: query name: type required: false type: string - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Filter fields by favourite status in: query name: onlyFavorites required: false type: boolean - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Count the datapoints associated to the user in this group. tags: - Groups '/groups/{id}/favourite': put: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '403': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: 'Fast switch the "favourite" field of a group' tags: - Groups '/groups/{id}/hits': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - custom in: query name: timeframe required: true type: string - description: Limit results to this number format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: "Offset where to start from (it's the lastKey field in the response object)" in: query name: offset required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' enum: - spiders - uniques - nonuniques - conversions in: query name: filter required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve the list of events related to this group. tags: - Groups '/groups/{id}/notes': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: Patch requests in: body name: note required: true schema: $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '403': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: 'Fast patch the "notes" field of a group' tags: - Groups '/groups/{id}/reports': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: Type of the report. enum: - browsers - browsersfamilies - platforms - cities - countries - isps - ips - oss - ossfamilies - keywords - referrers - destinations - languages - params in: query name: type required: true type: string - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - beginning - custom in: query name: timeframe required: true type: string - description: Type of the event you want to filter this report with. By default no filter is applied. enum: - clicks - views in: query name: hittype required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Tops.Top' '401': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: Retrieve a top report connected to this group tags: - Groups /hits: get: consumes: [] deprecated: false parameters: - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - custom in: query name: timeframe required: true type: string - description: Limit results to this number format: int32 in: query name: limit required: false type: integer - description: "Offset where to start from (it's the lastKey field in the response object)" in: query name: offset required: false type: string - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string - description: 'Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions")' enum: - spiders - uniques - nonuniques - conversions in: query name: filter required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitListPage' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve the list of events related to this account. tags: - Hits /me: get: consumes: [] deprecated: false produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.User' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve current account data tags: - Me /me/plan: get: consumes: [] deprecated: false produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Accounting.Plan' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve current account plan tags: - Me /reports: get: consumes: [] deprecated: false parameters: - description: Type of the report. enum: - browsers - browsersfamilies - platforms - cities - countries - isps - ips - oss - ossfamilies - keywords - referrers - destinations - languages - params in: query name: type required: true type: string - description: Timeframe of the request. See list at $timeframeList enum: - yesterday - last7 - last30 - lastmonth - currentmonth - previousmonth - last90 - last120 - last180 - beginning - custom in: query name: timeframe required: true type: string - description: Type of the event you want to filter this report with. By default no filter is applied. in: query name: hittype required: false type: string - description: 'Filter by this group id (mutually exclusive with "datapoint" and "conversion")' format: int64 in: query name: group required: false type: integer - description: 'Filter by this datapoint id (mutually exclusive with "group" and "conversion")' format: int64 in: query name: datapoint required: false type: integer - description: 'Filter by this conversion id (mutually exclusive with "datapoint" and "group")' format: int64 in: query name: conversion required: false type: integer - description: 'If using a "custom" timeFrame you can specify the starting day (YYYYMMDD)' in: query name: fromDay required: false type: string - description: 'If using a "custom" timeFrame you can specify the ending day (YYYYMMDD)' in: query name: toDay required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Tops.Top' '401': description: Forbidden '404': description: Not found '500': description: Internal Server Error summary: Retrieve a top report tags: - Reports /retargeting: get: consumes: [] deprecated: false parameters: - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the retargeting scripts associated to the user tags: - Retargeting post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: The body of the retargeting script in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Retargeting.RetargetingScript' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Creates a retargeting script tags: - Retargeting /retargeting/count: get: consumes: [] deprecated: false produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve count of retargeting scripts tags: - Retargeting '/retargeting/{id}': delete: consumes: [] deprecated: false parameters: - description: The id of the retargeting script format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Deletes a retargeting script (and remove associations) tags: - Retargeting get: consumes: [] deprecated: false parameters: - description: The id of the retargeting script format: int64 in: path name: id required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Retargeting.RetargetingScript' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Get a retargeting script object tags: - Retargeting post: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: The id of the retargeting script format: int64 in: path name: id required: true type: integer - description: The body of the retargeting script in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Retargeting.RetargetingScript' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Updates a retargeting script tags: - Retargeting '/retargeting/{id}/datapoints': get: consumes: [] deprecated: false parameters: - description: Id of the retargeting script format: int64 in: path name: id required: true type: integer - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Filter fields by favourite status in: query name: onlyFavorites required: false type: boolean - description: Field to sort by in: query name: sortBy required: false type: string - description: 'Direction of sort "asc" or "desc"' enum: - asc - desc in: query name: sortDirection required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the datapoints associated to the retargeting script. tags: - Retargeting '/retargeting/{id}/datapoints/count': get: consumes: [] deprecated: false parameters: - description: Id of the group format: int64 in: path name: id required: true type: integer - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: A comma separated list of tags you want to filter with. in: query name: tags required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Filter fields by favourite status in: query name: onlyFavorites required: false type: boolean - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Count the datapoints associated to the retargeting script. tags: - Retargeting /tags: get: consumes: [] deprecated: false parameters: - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Name of the tag in: query name: name required: false type: string - description: Comma separated list of datapoints id to filter by in: query name: datapoints required: false type: string - description: Comma separated list of groups id to filter by in: query name: groups required: false type: string - description: Type of entity related to the tag enum: - tp - tl - dp - gr in: query name: type required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the groups associated to the user filtered by this tag. tags: - Tags post: consumes: - application/json - text/json - application/x-www-form-urlencoded deprecated: false parameters: - description: The body of the tag in: body name: value required: true schema: $ref: '#/definitions/Api.Core.Dto.Tags.Tag' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Create a tag tags: - Tags /tags/count: get: consumes: [] deprecated: false parameters: - description: Name of the tag in: query name: name required: false type: string - description: Comma separated list of datapoints id to filter by in: query name: datapoints required: false type: string - description: Comma separated list of groups id to filter by in: query name: groups required: false type: string - description: Type of entity related to the tag enum: - tp - tl - dp - gr in: query name: type required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/System.Object' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the groups associated to the user filtered by this tag. tags: - Tags '/tags/{tagId}': delete: consumes: [] deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/System.Object' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete a tag tags: - Tags get: consumes: [] deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Dto.Tags.Tag' '401': description: Unauthorized '500': description: Internal Server Error summary: Retrieve a tag tags: - Tags '/tags/{tagId}/datapoints': delete: consumes: [] deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete the association of this tag with all datapoints tags: - Tags get: consumes: [] deprecated: false parameters: - description: Id of the tag. format: int64 in: path name: tagId required: true type: integer - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: 'Type of the datapoint ("tp"/"tl")' enum: - tp - tl in: query name: type required: false type: string - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the datapoints associated to the user filtered by this tag tags: - Tags '/tags/{tagId}/datapoints/count': get: consumes: [] deprecated: false parameters: - description: Id of the tag. format: int64 in: path name: tagId required: true type: integer - description: 'Type of the datapoint ("tp"/"tl")' enum: - tp - tl in: query name: type required: false type: string - description: Status of the datapoint enum: - deleted - active - paused - spam in: query name: status required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude datapoints created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude datapoints created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Count the datapoints associated to the user filtered by this tag tags: - Tags '/tags/{tagId}/datapoints/patch': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer - description: The body patch in: body name: data required: true schema: $ref: '#/definitions/Api.Core.Requests.PatchBody' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Associate/Deassociate a tag with a datapoint tags: - Tags '/tags/{tagId}/groups': delete: consumes: [] deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Delete the association of this tag with all groups tags: - Tags get: consumes: [] deprecated: false parameters: - description: Id of the tag. format: int64 in: path name: tagId required: true type: integer - default: 0 description: Where to start when retrieving elements. Default is 0 if not specified. format: int32 in: query minLength: 0 name: offset required: false type: integer - default: 20 description: Maximum elements to retrieve. Default to 20 if not specified. format: int32 in: query maxLength: 0 minLength: 0 name: limit required: false type: integer - description: Status of the datapoint enum: - deleted - active in: query name: status required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude groups created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude groups created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: List of all the groups associated to the user filtered by this tag. tags: - Tags '/tags/{tagId}/groups/count': get: consumes: [] deprecated: false parameters: - description: Id of the tag. format: int64 in: path name: tagId required: true type: integer - description: Status of the datapoint enum: - deleted - active in: query name: status required: false type: string - description: Filter fields by this pattern in: query name: textSearch required: false type: string - description: Exclude groups created before this date (YYYYMMDD) in: query name: createdAfter required: false type: string - description: Exclude groups created after this date (YYYYMMDD) in: query name: createdBefore required: false type: string produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.CountResponce' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Count the groups associated to the user filtered by this tag tags: - Tags '/tags/{tagId}/groups/patch': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer - description: The body patch in: body name: data required: true schema: $ref: '#/definitions/Api.Core.Requests.PatchBody' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '404': description: Not found '500': description: Internal Server Error summary: Associate/Deassociate a tag with a group tags: - Tags '/tags/{tagId}/name': put: consumes: - application/json - text/json - application/xml - text/xml - application/x-www-form-urlencoded deprecated: false parameters: - description: Id of the tag format: int64 in: path name: tagId required: true type: integer - description: The body patch in: body name: data required: true schema: $ref: '#/definitions/Api.Core.Requests.GenericTextPatch' produces: - application/json - text/json - application/xml - text/xml responses: '200': description: '' schema: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' '401': description: Unauthorized '500': description: Internal Server Error summary: Fast patch a tag name tags: - Tags definitions: Api.Core.Dto.Accounting.ConversionOptions: properties: hideComCost: type: boolean hideCost: type: boolean hideCount: type: boolean hideParams: type: boolean hideValue: type: boolean percentCommission: format: int32 type: integer percentValue: format: int32 type: integer type: object Api.Core.Dto.Accounting.DomainWhitelistEntry: properties: id: type: string name: type: string type: object Api.Core.Dto.Accounting.ExtendedGrants: properties: allowAllGrants: type: boolean allowGroupCreation: type: boolean type: object Api.Core.Dto.Accounting.Guest: properties: apiKey: type: string conversionOptions: $ref: '#/definitions/Api.Core.Dto.Accounting.ConversionOptions' creationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string currentGrant: $ref: '#/definitions/Api.Core.Dto.Grants.Grant' dateFormat: type: string decimalSeparator: type: string email: type: string extendedGrants: $ref: '#/definitions/Api.Core.Dto.Accounting.ExtendedGrants' groupGrants: format: int64 type: integer hitOptions: $ref: '#/definitions/Api.Core.Dto.Accounting.HitOptions' id: format: int64 type: integer key: type: string language: type: string loginCount: format: int32 type: integer name: type: string notes: type: string numberGroupSeparator: type: string password: type: string timeFormat: enum: - AmPm - H24 type: string timeZone: format: int32 type: integer timeframeMinDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string timezonename: type: string tlGrants: format: int64 type: integer tpGrants: format: int64 type: integer userName: type: string type: object Api.Core.Dto.Accounting.HitOptions: properties: hideReferrer: type: boolean type: object Api.Core.Dto.Accounting.IpBlacklistEntry: properties: id: type: string ip: type: string type: object Api.Core.Dto.Accounting.Plan: properties: allowedPersonalDomains: format: int32 type: integer allowedPersonalUrls: format: int32 type: integer billingPeriodEnd: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string billingPeriodStart: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string bonusMonthlyEvents: format: int64 type: integer maximumDatapoints: format: int64 type: integer maximumGuests: format: int64 type: integer monthlyEvents: format: int64 type: integer name: type: string price: format: double type: number profileId: format: int64 type: integer recurring: type: boolean recurringPeriod: format: int32 type: integer usedDatapoints: format: int64 type: integer usedMonthlyEvents: format: int64 type: integer type: object Api.Core.Dto.Accounting.User: properties: boGoVal: type: string bonusClicks: format: int64 type: integer companyName: type: string companyRole: type: string email: type: string firstName: type: string lastName: type: string phone: type: string redirectOnly: type: boolean registrationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string timeframeMinDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string timezone: format: int32 type: integer timezonename: type: string type: object Api.Core.Dto.Aggregated.AggregatedResult: properties: activityDay: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string commissionsCost: format: double type: number conversionsCost: format: double type: number conversionsValue: format: double type: number convertedClicks: format: int64 type: integer entityData: $ref: '#/definitions/System.Object' entityId: type: string fromDay: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string hourlyBreakDown: additionalProperties: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' type: object lastHitDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string spiderHitsCount: format: int64 type: integer toDay: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string totalClicks: format: int64 type: integer totalViews: format: int64 type: integer uniqueClicks: format: int64 type: integer uniqueConversions: format: int64 type: integer uniqueViews: format: int64 type: integer type: object Api.Core.Dto.Aggregated.AggregatedSummaryResult: properties: count: format: int64 type: integer limit: format: int32 type: integer offset: format: int64 type: integer result: items: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' type: array type: object Api.Core.Dto.ClickStream.Hit: properties: accessTime: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string browser: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitBrowserInfo' clientLanguage: type: string conversion1: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' conversion2: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' conversion3: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' conversion4: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' conversion5: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' conversions: items: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitConversionInfo' type: array entity: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitDatapointInfo' ip: type: string isProxy: type: string isSpider: type: string isUnique: type: string location: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitLocationInfo' org: type: string os: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitOsInfo' queryParams: type: string realDestinationUrl: type: string referer: type: string source: $ref: '#/definitions/Api.Core.Dto.ClickStream.HitSource' type: type: string type: object Api.Core.Dto.ClickStream.HitBrowserInfo: properties: browserType: type: string familyId: format: int64 type: integer familyName: type: string id: format: int64 type: integer name: type: string type: object Api.Core.Dto.ClickStream.HitConversionInfo: properties: accessTime: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string comcost: format: double type: number cost: format: double type: number date: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string deleted: type: boolean id: format: int64 type: integer name: type: string parameter: type: string value: format: double type: number type: object Api.Core.Dto.ClickStream.HitDatapointInfo: properties: creationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string datapointFavourite: type: boolean datapointId: format: int64 type: integer datapointName: type: string datapointTitle: type: string datapointType: type: string destinationUrl: type: string groupId: format: int64 type: integer groupName: type: string isABTest: type: boolean isPrivateShared: type: boolean isPublic: type: boolean notes: type: string status: enum: - Active - Paused - Abuse - Deleted type: string tags: items: $ref: '#/definitions/Api.Core.Dto.Tags.Tag' type: array trackingCode: type: string type: object Api.Core.Dto.ClickStream.HitListPage: properties: hits: items: $ref: '#/definitions/Api.Core.Dto.ClickStream.Hit' type: array lastKey: type: string type: object Api.Core.Dto.ClickStream.HitLocationInfo: properties: areacode: type: string city: type: string country: type: string latitude: format: double type: number longitude: format: double type: number metrocode: type: string organization: type: string postalcode: type: string region: type: string regionName: type: string type: object Api.Core.Dto.ClickStream.HitOsInfo: properties: familyId: format: int64 type: integer familyName: type: string id: format: int64 type: integer name: type: string type: object Api.Core.Dto.ClickStream.HitSource: properties: id: format: int64 type: integer name: type: string param: type: string type: object Api.Core.Dto.Conversions.Conversion: properties: code: type: string creationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string deleted: type: boolean description: type: string id: format: int64 type: integer name: type: string protocol: enum: - Http - Https type: string value: format: double type: number type: object Api.Core.Dto.Datapoints.BrowserBaseDestinationItem: properties: emailDestinationUrl: type: string mobileDestinationUrl: type: string spidersDestinationUrl: type: string type: object Api.Core.Dto.Datapoints.Datapoint: properties: creationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string encodeIp: type: boolean fifthConversionId: format: int64 type: integer fifthConversionName: type: string firstConversionId: format: int64 type: integer firstConversionName: type: string fourthConversionId: format: int64 type: integer fourthConversionName: type: string groupId: format: int64 type: integer groupName: type: string id: format: int64 type: integer isPublic: type: boolean isSecured: type: boolean lightTracking: type: boolean name: type: string notes: type: string preferred: type: boolean redirectOnly: type: boolean secondConversionId: format: int64 type: integer secondConversionName: type: string status: enum: - Active - Paused - Abuse - Deleted type: string tags: items: $ref: '#/definitions/Api.Core.Dto.Tags.Tag' type: array thirdConversionId: format: int64 type: integer thirdConversionName: type: string title: type: string trackingCode: type: string type: enum: - TrackingLink - TrackingPixel type: string typeTL: $ref: '#/definitions/Api.Core.Dto.Datapoints.TrackingLinkSpecifics' typeTP: $ref: '#/definitions/Api.Core.Dto.Datapoints.TrackingPixelSpecifics' writePermited: type: boolean type: object Api.Core.Dto.Datapoints.DatapointRetargetingInfo: properties: id: format: int64 type: integer name: type: string type: object Api.Core.Dto.Datapoints.MultipleDestinationItem: properties: url: type: string type: object Api.Core.Dto.Datapoints.TrackingLinkSpecifics: properties: appendQuery: type: boolean browserDestinationItem: $ref: '#/definitions/Api.Core.Dto.Datapoints.BrowserBaseDestinationItem' destinationMode: enum: - Simple - RandomDestination - DestinationByLanguage - SpilloverDestination - DynamicUrl - BrowserDestination - DestinationByNation - UniqueDestination - SequentialDestination - WeightedDestination type: string domainId: format: int32 type: integer encodeUrl: type: boolean expirationClicks: format: int64 type: integer expirationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string firstUrl: type: string goDomainId: format: int32 type: integer hideUrl: type: boolean hideUrlTitle: type: string isABTest: type: boolean password: type: string pauseAfterClicksExpiration: type: boolean pauseAfterDateExpiration: type: boolean randomDestinationItems: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.MultipleDestinationItem' type: array redirectType: enum: - PermanentRedirect - TemporaryRedirect type: string referrerClean: enum: - None - Clean - Myself type: string scripts: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.DatapointRetargetingInfo' type: array sequentialDestinationItems: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.MultipleDestinationItem' type: array spilloverDestinationItems: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.MultipleDestinationItem' type: array uniqueDestinationItem: $ref: '#/definitions/Api.Core.Dto.Datapoints.UniqueDestinationItem' url: type: string urlAfterClicksExpiration: type: string urlAfterDateExpiration: type: string urlsByLanguage: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.UrlByLanguageItem' type: array urlsByNation: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.UrlByNationItem' type: array weightedDestinationItems: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.WeightedDestinationItem' type: array type: object Api.Core.Dto.Datapoints.TrackingPixelSpecifics: properties: parameterNote: type: string type: object Api.Core.Dto.Datapoints.UniqueDestinationItem: properties: firstDestinationUrl: type: string type: object Api.Core.Dto.Datapoints.UrlByLanguageItem: properties: languageCode: type: string url: type: string type: object Api.Core.Dto.Datapoints.UrlByNationItem: properties: nation: type: string url: type: string type: object Api.Core.Dto.Datapoints.WeightedDestinationItem: properties: url: type: string weight: format: int32 type: integer type: object Api.Core.Dto.Domains.Domain: properties: custom404: type: string customHomepage: type: string id: format: int64 type: integer name: type: string type: enum: - System - Go - Dedicated - Personal type: string type: object Api.Core.Dto.EntityUriLong: properties: id: format: int64 type: integer uri: type: string type: object Api.Core.Dto.Grants.Grant: properties: DatapointType: type: string Entity: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' EntityName: type: string EntityType: type: string Type: type: string type: object Api.Core.Dto.Groups.Group: properties: creationDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string deleted: type: boolean id: format: int64 type: integer isPublic: type: boolean name: type: string notes: type: string preferred: type: boolean redirectOnly: type: boolean tags: items: $ref: '#/definitions/Api.Core.Dto.Tags.Tag' type: array writePermited: type: boolean type: object Api.Core.Dto.Retargeting.RetargetingScript: properties: id: format: int64 type: integer name: type: string script: type: string type: object Api.Core.Dto.Tags.Tag: properties: datapoints: items: format: int64 type: integer type: array groups: items: format: int64 type: integer type: array id: format: int64 type: integer name: type: string type: object Api.Core.Dto.Tops.Top: properties: createdAt: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string data: items: $ref: '#/definitions/Api.Core.Dto.Tops.TopItem' type: array key: type: string type: object Api.Core.Dto.Tops.TopItem: properties: entityData: $ref: '#/definitions/System.Object' id: type: string lastHitDate: description: ' (A date in "YmdHis" format)' example: '20120203120530' type: string spiderClicks: format: int64 type: integer spiderHits: format: int64 type: integer spiderViews: format: int64 type: integer totalClicks: format: int64 type: integer totalCommissionsCost: format: double type: number totalConversions: format: int64 type: integer totalConversionsCost: format: double type: number totalConversionsValue: format: double type: number totalHits: format: int64 type: integer totalViews: format: int64 type: integer uniqueClicks: format: int64 type: integer uniqueHits: format: int64 type: integer uniqueViews: format: int64 type: integer type: object Api.Core.Requests.ConversionPatchBody: properties: Action: type: string Id: format: int64 type: integer ReplaceId: format: int64 type: integer type: object Api.Core.Requests.DatapointsBatch: properties: List: items: $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' type: array type: object Api.Core.Requests.DeleteBatch: properties: Entities: items: $ref: '#/definitions/Api.Core.Dto.EntityUriLong' type: array type: object Api.Core.Requests.GenericTextPatch: properties: Text: type: string type: object Api.Core.Requests.PatchBody: properties: Action: type: string Id: format: int64 type: integer type: object Api.Core.Requests.PatchBodyBatch: properties: PatchRequests: items: $ref: '#/definitions/Api.Core.Requests.PatchBody' type: array type: object Api.Core.Requests.PermissionPatchRequest: properties: Action: type: string Id: format: int64 type: integer Verb: type: string type: object Api.Core.Responses.CountResponce: properties: count: format: int64 type: integer type: object 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.DomainWhitelistEntry]': properties: entities: items: $ref: '#/definitions/Api.Core.Dto.Accounting.DomainWhitelistEntry' type: array type: object 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Accounting.IpBlacklistEntry]': properties: entities: items: $ref: '#/definitions/Api.Core.Dto.Accounting.IpBlacklistEntry' type: array type: object 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Aggregated.AggregatedResult]': properties: entities: items: $ref: '#/definitions/Api.Core.Dto.Aggregated.AggregatedResult' type: array type: object 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.ClickStream.Hit]': properties: entities: items: $ref: '#/definitions/Api.Core.Dto.ClickStream.Hit' type: array type: object 'Api.Core.Responses.EntitiesResponse[Api.Core.Dto.Grants.Grant]': properties: entities: items: $ref: '#/definitions/Api.Core.Dto.Grants.Grant' type: array type: object 'Api.Core.Responses.EntitiesResponse[Api.Core.Responses.EntityUri[System.Int64]]': properties: entities: items: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' type: array type: object 'Api.Core.Responses.EntityUri[System.Int64]': properties: id: format: int64 type: integer uri: type: string type: object 'Api.Core.Responses.ModifyBatchItemResponce[Api.Core.Dto.Datapoints.Datapoint,System.Int64]': properties: entityData: $ref: '#/definitions/Api.Core.Dto.Datapoints.Datapoint' errors: items: $ref: '#/definitions/ClickMeter.Infrastructure.Validation.ValidationFailure' type: array result: $ref: '#/definitions/Api.Core.Responses.EntityUri[System.Int64]' status: type: string type: object ClickMeter.Infrastructure.Validation.ValidationFailure: properties: code: $ref: '#/definitions/System.Object' errorMessage: type: string errorValue: $ref: '#/definitions/System.Object' property: type: string type: object System.Object: properties: {} type: object