# ClickMeter API API

> ClickMeter API API on Apizie: 104 endpoints (Retrieve current account data, Update current account data, Retrieve list of a domains allowed to redirect in DDU mode, Create an domain entry, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/business:clickmeter/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:clickmeter`
- Category: Business
- Status: byok
- Source: http://www.clickmeter.com/api
- Page: https://zieapi.vercel.app/api/business/clickmeter
- OpenAPI: https://zieapi.vercel.app/api/business/clickmeter/openapi.json

Api dashboard for ClickMeter API

## Endpoints

### Retrieve current account data
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get` (byok)

### Update current account data
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve list of a domains allowed to redirect in DDU mode
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-domain-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |

### Create an domain entry
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-put-domain-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete an domain entry
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-delete-domain-whitelist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| whitelistId | string | yes | The id of the domain to delete |

### Retrieve list of a guest
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-guests` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| textSearch | string | no | Filter fields by this pattern |

### Create a guest
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-put-guest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve count of guests
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-guests-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| textSearch | string | no | Filter fields by this pattern |

### Retrieve a guest
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-guest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |

### Update a guest
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-post-guest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |
| body | object | yes | JSON request body |

### Delete a guest
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-delete-guest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |

### Retrieve permissions for a guest
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |
| entityType | string | no | Can be "datapoint" or "group" |
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| type | string | no | Can be "w" or "r" |
| entityId | integer | no | Optional id of the datapoint/group entity to filter by |

### Retrieve count of the permissions for a guest
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-permissions-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |
| entityType | string | no | Can be "datapoint" or "group" |
| type | string | no | Can be "w" or "r" |
| entityId | integer | no | Optional id of the datapoint/group entity to filter by |

### Change the permission on a shared object
`POST https://zieapi.vercel.app/v1/business:clickmeter/post-account-guests-guest-id-type-permissions-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |
| type | string | yes | Can be "datapoint" or "group" |
| body | object | yes | JSON request body |

### Change the permission on a shared object
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-patch-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| guestId | integer | yes | Id of the guest |
| type | string | yes | Can be "datapoint" or "group" |
| body | object | yes | JSON request body |

### Retrieve list of a ip to exclude from event tracking
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-ip-blacklist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |

### Create an ip blacklist entry
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-put-ip-blacklist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete an ip blacklist entry
`POST https://zieapi.vercel.app/v1/business:clickmeter/account-delete-ip-blacklist` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| blacklistId | string | yes | The id of the ip to delete |

### Retrieve current account plan
`GET https://zieapi.vercel.app/v1/business:clickmeter/account-get-plan` (byok)

### Retrieve statistics about this customer for a timeframe
`GET https://zieapi.vercel.app/v1/business:clickmeter/aggregated-get-statistics-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| hourly | boolean | no | If using "yesterday" or "today" timeframe you can ask for the hourly detail |
| onlyFavorites | string | no |  |

### Retrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month)
`GET https://zieapi.vercel.app/v1/business:clickmeter/aggregated-get-statistics-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Retrieve statistics about a subset of conversions for a timeframe with conversions data
`GET https://zieapi.vercel.app/v1/business:clickmeter/aggregated-get-conversions-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of conversion ("deleted"/"active") |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| textSearch | string | no | Filter fields by this pattern |

### Retrieve statistics about a subset of datapoints for a timeframe with datapoints data
`GET https://zieapi.vercel.app/v1/business:clickmeter/aggregated-get-datapoints-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| type | string | yes | Type of datapoint ("tl"/"tp") |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of datapoint ("deleted"/"active"/"paused"/"spam") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the datapoint marked as favourite |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| groupId | integer | no | Filter by this group id |
| textSearch | string | no | Filter fields by this pattern |

### Retrieve statistics about a subset of groups for a timeframe with groups data
`GET https://zieapi.vercel.app/v1/business:clickmeter/aggregated-get-groups-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of group ("deleted"/"active") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the group marked as favourite |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| textSearch | string | no | Filter fields by this pattern |

### Retrieve the latest list of events of this account. Limited to last 100.
`GET https://zieapi.vercel.app/v1/business:clickmeter/click-stream-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| group | integer | no | Filter by this group id (mutually exclusive with "datapoint" and "conversion") |
| datapoint | integer | no | Filter by this datapoint id (mutually exclusive with "group" and "conversion") |
| conversion | integer | no | Filter by this conversion id (mutually exclusive with "datapoint" and "group") |
| pageSize | integer | no | Limit results to this number |
| filter | string | no | Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions") |

### Retrieve a list of conversions
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| status | string | no | Status of conversion ("deleted"/"active") |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude conversions created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude conversions created after this date (YYYYMMDD) |

### Create a conversion
`POST https://zieapi.vercel.app/v1/business:clickmeter/conversions-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some…
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get-statistics-all-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of conversion ("deleted"/"active") |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Retrieve a count of conversions
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | Status of conversion ("deleted"/"active") |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude conversions created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude conversions created after this date (YYYYMMDD) |

### Retrieve conversion specified by id
`GET https://zieapi.vercel.app/v1/business:clickmeter/get-conversions-conversion-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |

### Update conversion specified by id
`POST https://zieapi.vercel.app/v1/business:clickmeter/conversions-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| body | object | yes | JSON request body |

### Delete conversion specified by id
`POST https://zieapi.vercel.app/v1/business:clickmeter/conversions-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |

### Retrieve statistics about this conversion for a timeframe
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get-statistics-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| tag | string | no | Filter by this tag name |
| favourite | boolean | no | Is the datapoint marked as favourite |
| hourly | boolean | no | If using "yesterday" or "today" timeframe you can ask for the hourly detail |

### Retrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month)
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get-statistics-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Retrieve a list of datapoints connected to this conversion
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get-datapoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| type | string | no | Type of datapoint ("tl"/"tp") |
| status | string | no | Status of datapoint ("deleted"/"active"/"paused"/"spam") |
| tags | string | no | Filter by this tag name |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Modify the association between a conversion and multiple datapoints
`POST https://zieapi.vercel.app/v1/business:clickmeter/put-conversions-conversion-id-datapoints-batch-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| body | object | yes | JSON request body |

### Retrieve a count of datapoints connected to this conversion
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get-datapoints-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| type | string | no | Type of datapoint ("tl"/"tp") |
| status | string | no | Status of datapoint ("deleted"/"active"/"paused"/"spam") |
| tags | string | no | Filter by this tag name |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Modify the association between a conversion and a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/conversions-patch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| body | object | yes | JSON request body |

### Retrieve the list of events related to this conversion.
`GET https://zieapi.vercel.app/v1/business:clickmeter/conversions-get-hits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| timeframe | string | yes | Timeframe of the request. See list at $timeframeList |
| limit | integer | no | Limit results to this number |
| offset | string | no | Offset where to start from (it's the lastKey field in the response object) |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| filter | string | no | Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions") |

### Fast patch the "notes" field of a conversion
`POST https://zieapi.vercel.app/v1/business:clickmeter/conversions-patch-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| conversionId | integer | yes | Id of the conversion |
| body | object | yes | JSON request body |

### List of all the datapoints associated to the user
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-get` (byok)

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

### Create a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve statistics about this customer for a timeframe by groups
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-get-statistics-aggregated-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| type | string | no | Type of datapoint ("tl"/"tp") |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| hourly | boolean | no | If using "yesterday" or "today" timeframe you can ask for the hourly detail |
| status | string | no | Status of datapoint ("deleted"/"active"/"paused"/"spam") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the datapoint is marked as favourite |

### Retrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity…
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-get-statistics-all-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | yes | Type of datapoint ("tl"/"tp") |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of datapoint ("deleted"/"active"/"paused"/"spam") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the datapoint is marked as favourite |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Update multiple datapoints
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-batch-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Create multiple datapoints
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-batch-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Delete multiple datapoints
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-batch-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Count the datapoints associated to the user
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | no | Type of the datapoint ("tp"/"tl") |
| status | string | no | Status of the datapoint |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| onlyFavorites | boolean | no | Filter fields by favourite status |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Get a datapoint
`GET https://zieapi.vercel.app/v1/business:clickmeter/get-datapoints-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the datapoint |

### Update a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the datapoint |
| body | object | yes | JSON request body |

### Delete a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the datapoint |

### Retrieve statistics about this datapoint for a timeframe
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-get-statistics-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the datapoint |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| hourly | boolean | no | If using "yesterday" or "today" timeframe you can ask for the hourly detail |

### Retrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month)
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-get-statistics-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the datapoint |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Fast switch the "favourite" field of a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-patch-favourite` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the datapoint |

### Retrieve the list of events related to this datapoint.
`GET https://zieapi.vercel.app/v1/business:clickmeter/data-points-get-hits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the datapoint |
| timeframe | string | yes | Timeframe of the request. See list at $timeframeList |
| limit | integer | no | Limit results to this number |
| offset | string | no | Offset where to start from (it's the lastKey field in the response object) |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| filter | string | no | Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions") |

### Fast patch the "notes" field of a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/data-points-patch-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the datapoint |
| body | object | yes | JSON request body |

### Retrieve a list of domains
`GET https://zieapi.vercel.app/v1/business:clickmeter/domains-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| type | string | no | Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system" |
| name | string | no | Filter domains with this anmen |

### Create a domain
`POST https://zieapi.vercel.app/v1/business:clickmeter/domains-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve count of domains
`GET https://zieapi.vercel.app/v1/business:clickmeter/domains-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| type | string | no | Type of domain ("system"/"go"/"personal"/"dedicated"). If not specified default is "system" |
| name | string | no | Filter domains with this anmen |

### Get a domain
`GET https://zieapi.vercel.app/v1/business:clickmeter/get-domains-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of domain |

### Update a domain
`POST https://zieapi.vercel.app/v1/business:clickmeter/domains-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of domain |
| body | object | yes | JSON request body |

### Delete a domain
`POST https://zieapi.vercel.app/v1/business:clickmeter/domains-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of domain |

### List of all the groups associated to the user.
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |
| status | string | no | Status of the group |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude groups created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude groups created after this date (YYYYMMDD) |
| write | boolean | no | Write permission |

### Create a group
`POST https://zieapi.vercel.app/v1/business:clickmeter/groups-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve statistics about this customer for a timeframe by groups
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-statistics-aggregated-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| hourly | boolean | no | If using "yesterday" or "today" timeframe you can ask for the hourly detail |
| status | string | no | Status of group ("deleted"/"active") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the group is marked as favourite |

### Retrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity…
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-statistics-all-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of group ("deleted"/"active") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the group is marked as favourite |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Count the groups associated to the user.
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | no | Status of the datapoint |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude groups created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude groups created after this date (YYYYMMDD) |
| write | boolean | no | Write permission |

### Get a group
`GET https://zieapi.vercel.app/v1/business:clickmeter/get-groups-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the group |

### Update a group
`POST https://zieapi.vercel.app/v1/business:clickmeter/groups-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the group |
| body | object | yes | JSON request body |

### Delete group specified by id
`POST https://zieapi.vercel.app/v1/business:clickmeter/groups-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |

### Retrieve statistics about this group for a timeframe
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-statistics-single` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| hourly | boolean | no | If using "yesterday" or "today" timeframe you can ask for the hourly detail |

### Retrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month)
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-statistics-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| groupBy | string | no | The temporal entity you want to group by ("week"/"month"). If unspecified is "day". |

### Retrieve statistics about a subset of datapoints for a timeframe with datapoints data
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-datapoints-summary` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Filter by this group id |
| timeFrame | string | yes | Timeframe of the request. See list at $timeframeList |
| type | string | no | Type of datapoint ("tl"/"tp") |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| status | string | no | Status of datapoint ("deleted"/"active"/"paused"/"spam") |
| tag | string | no | A comma separated list of tags you want to filter with. |
| favourite | boolean | no | Is the datapoint marked as favourite |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| offset | integer | no | Offset where to start from |
| limit | integer | no | Limit results to this number |
| textSearch | string | no | Filter fields by this pattern |

### List of all the datapoints associated to the user in this group.
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-datapoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |
| type | string | no | Type of the datapoint ("tp"/"tl") |
| status | string | no | Status of the datapoint |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| onlyFavorites | boolean | no | Filter fields by favourite status |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Create a datapoint in this group
`POST https://zieapi.vercel.app/v1/business:clickmeter/groups-put-datapoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the group |
| body | object | yes | JSON request body |

### Count the datapoints associated to the user in this group.
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-datapoints-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| type | string | no | Type of the datapoint ("tp"/"tl") |
| status | string | no | Status of the datapoint |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| onlyFavorites | boolean | no | Filter fields by favourite status |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Fast switch the "favourite" field of a group
`POST https://zieapi.vercel.app/v1/business:clickmeter/groups-patch-favourite` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |

### Retrieve the list of events related to this group.
`GET https://zieapi.vercel.app/v1/business:clickmeter/groups-get-hits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| timeframe | string | yes | Timeframe of the request. See list at $timeframeList |
| limit | integer | no | Limit results to this number |
| offset | string | no | Offset where to start from (it's the lastKey field in the response object) |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| filter | string | no | Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions") |

### Fast patch the "notes" field of a group
`POST https://zieapi.vercel.app/v1/business:clickmeter/groups-patch-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| body | object | yes | JSON request body |

### Retrieve the list of events related to this account.
`GET https://zieapi.vercel.app/v1/business:clickmeter/hits-get-hits` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| timeframe | string | yes | Timeframe of the request. See list at $timeframeList |
| limit | integer | no | Limit results to this number |
| offset | string | no | Offset where to start from (it's the lastKey field in the response object) |
| fromDay | string | no | If using a "custom" timeFrame you can specify the starting day (YYYYMMDD) |
| toDay | string | no | If using a "custom" timeFrame you can specify the ending day (YYYYMMDD) |
| filter | string | no | Filter event type ("spiders"/"uniques"/"nonuniques"/"conversions") |

### Retrieve current account data
`GET https://zieapi.vercel.app/v1/business:clickmeter/me-get-me` (byok)

### Retrieve current account plan
`GET https://zieapi.vercel.app/v1/business:clickmeter/me-get-me-plan` (byok)

### List of all the retargeting scripts associated to the user
`GET https://zieapi.vercel.app/v1/business:clickmeter/retargeting-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |

### Creates a retargeting script
`POST https://zieapi.vercel.app/v1/business:clickmeter/retargeting-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### Retrieve count of retargeting scripts
`GET https://zieapi.vercel.app/v1/business:clickmeter/retargeting-count` (byok)

### Get a retargeting script object
`GET https://zieapi.vercel.app/v1/business:clickmeter/get-retargeting-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the retargeting script |

### Updates a retargeting script
`POST https://zieapi.vercel.app/v1/business:clickmeter/retargeting-post` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the retargeting script |
| body | object | yes | JSON request body |

### Deletes a retargeting script (and remove associations)
`POST https://zieapi.vercel.app/v1/business:clickmeter/retargeting-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | The id of the retargeting script |

### List of all the datapoints associated to the retargeting script.
`GET https://zieapi.vercel.app/v1/business:clickmeter/retargeting-get-datapoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the retargeting script |
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |
| status | string | no | Status of the datapoint |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| onlyFavorites | boolean | no | Filter fields by favourite status |
| sortBy | string | no | Field to sort by |
| sortDirection | string | no | Direction of sort "asc" or "desc" |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Count the datapoints associated to the retargeting script.
`GET https://zieapi.vercel.app/v1/business:clickmeter/retargeting-get-datapoints-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| id | integer | yes | Id of the group |
| status | string | no | Status of the datapoint |
| tags | string | no | A comma separated list of tags you want to filter with. |
| textSearch | string | no | Filter fields by this pattern |
| onlyFavorites | boolean | no | Filter fields by favourite status |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### List of all the groups associated to the user filtered by this tag.
`GET https://zieapi.vercel.app/v1/business:clickmeter/tags-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |
| name | string | no | Name of the tag |
| datapoints | string | no | Comma separated list of datapoints id to filter by |
| groups | string | no | Comma separated list of groups id to filter by |
| type | string | no | Type of entity related to the tag |

### Create a tag
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-put` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | yes | JSON request body |

### List of all the groups associated to the user filtered by this tag.
`GET https://zieapi.vercel.app/v1/business:clickmeter/tags-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| name | string | no | Name of the tag |
| datapoints | string | no | Comma separated list of datapoints id to filter by |
| groups | string | no | Comma separated list of groups id to filter by |
| type | string | no | Type of entity related to the tag |

### Retrieve a tag
`GET https://zieapi.vercel.app/v1/business:clickmeter/get-tags-tag-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |

### Delete a tag
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |

### List of all the datapoints associated to the user filtered by this tag
`GET https://zieapi.vercel.app/v1/business:clickmeter/tags-get-datapoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag. |
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |
| type | string | no | Type of the datapoint ("tp"/"tl") |
| status | string | no | Status of the datapoint |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Delete the association of this tag with all datapoints
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-delete-related-datapoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |

### Count the datapoints associated to the user filtered by this tag
`GET https://zieapi.vercel.app/v1/business:clickmeter/tags-get-datapoints-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag. |
| type | string | no | Type of the datapoint ("tp"/"tl") |
| status | string | no | Status of the datapoint |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude datapoints created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude datapoints created after this date (YYYYMMDD) |

### Associate/Deassociate a tag with a datapoint
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-patch-data-point` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |
| body | object | yes | JSON request body |

### List of all the groups associated to the user filtered by this tag.
`GET https://zieapi.vercel.app/v1/business:clickmeter/tags-get-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag. |
| offset | integer | no | Where to start when retrieving elements. Default is 0 if not specified. |
| limit | integer | no | Maximum elements to retrieve. Default to 20 if not specified. |
| status | string | no | Status of the datapoint |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude groups created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude groups created after this date (YYYYMMDD) |

### Delete the association of this tag with all groups
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-delete-related-groups` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |

### Count the groups associated to the user filtered by this tag
`GET https://zieapi.vercel.app/v1/business:clickmeter/tags-get-groups-count` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag. |
| status | string | no | Status of the datapoint |
| textSearch | string | no | Filter fields by this pattern |
| createdAfter | string | no | Exclude groups created before this date (YYYYMMDD) |
| createdBefore | string | no | Exclude groups created after this date (YYYYMMDD) |

### Associate/Deassociate a tag with a group
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-patch-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |
| body | object | yes | JSON request body |

### Fast patch a tag name
`POST https://zieapi.vercel.app/v1/business:clickmeter/tags-patch-tag-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| tagId | integer | yes | Id of the tag |
| body | object | yes | JSON request body |

## Example
```
curl "https://zieapi.vercel.app/v1/business:clickmeter/account-get" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the ClickMeter API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/business:clickmeter/account-get with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the ClickMeter API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. ClickMeter API itself also needs your own key from clickmeter.com.

### Can AI agents use the ClickMeter API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:clickmeter.

### What is the status of the ClickMeter API API?
Needs your own provider key (bring your own key)