Clickmeter

ClickMeter API

Api dashboard for ClickMeter API

Other#openapi#marketing

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

Api dashboard for ClickMeter API

Endpoints 104

Account

  • GETRetrieve current account data/account
  • POSTUpdate current account data/account
  • GETRetrieve list of a domains allowed to redirect in DDU mode/account/domainwhitelist?offset=0&limit=0
  • POSTCreate an domain entry/account/domainwhitelist
  • DELETEDelete an domain entry/account/domainwhitelist/:whitelistId
  • GETRetrieve list of a guest/account/guests?offset=0&limit=0&sortBy=string&sortDirection=asc&textSearch=string
  • POSTCreate a guest/account/guests
  • GETRetrieve count of guests/account/guests/count?textSearch=string
  • GETRetrieve a guest/account/guests/:guestId
  • POSTUpdate a guest/account/guests/:guestId
  • DELETEDelete a guest/account/guests/:guestId
  • GETRetrieve permissions for a guest/account/guests/:guestId/permissions?entityType=datapoint&offset=0&limit=0&type=r&entityId=0
  • GETRetrieve count of the permissions for a guest/account/guests/:guestId/permissions/count?entityType=datapoint&type=r&entityId=0
  • PUTChange the permission on a shared object/account/guests/:guestId/:type/permissions/patch
  • POSTChange the permission on a shared object/account/guests/:guestId/:type/permissions/patch
  • GETRetrieve list of a ip to exclude from event tracking/account/ipblacklist?offset=0&limit=0
  • POSTCreate an ip blacklist entry/account/ipblacklist
  • DELETEDelete an ip blacklist entry/account/ipblacklist/:blacklistId
  • GETRetrieve current account plan/account/plan

Aggregated

  • GETRetrieve statistics about this customer for a timeframe/aggregated?timeFrame=today&fromDay=string&toDay=string&hourly=true&onlyFavorites=string
  • GETRetrieve statistics about this customer for a timeframe grouped by some temporal entity (day/week/month)/aggregated/list?timeFrame=today&fromDay=string&toDay=string&groupBy=week
  • GETRetrieve statistics about a subset of conversions for a timeframe with conversions data/aggregated/summary/conversions?timeFrame=today&fromDay=string&toDay=string&status=deleted&sortBy=string&sortDirection=asc&offset=0&limit=0&textSearch=string
  • GETRetrieve statistics about a subset of datapoints for a timeframe with datapoints data/aggregated/summary/datapoints?timeFrame=today&type=tp&fromDay=string&toDay=string&status=deleted&tag=string&favourite=true&sortBy=string&sortDirection=asc&offset=0&limit=0&groupId=0&textSearch=string
  • GETRetrieve statistics about a subset of groups for a timeframe with groups data/aggregated/summary/groups?timeFrame=today&fromDay=string&toDay=string&status=deleted&tag=string&favourite=true&sortBy=string&sortDirection=asc&offset=0&limit=0&textSearch=string

ClickStream

  • GETRetrieve the latest list of events of this account. Limited to last 100./clickstream?group=0&datapoint=0&conversion=0&pageSize=50&filter=

Conversions

  • GETRetrieve a list of conversions/conversions?offset=0&limit=0&status=deleted&textSearch=string&createdAfter=string&createdBefore=string
  • POSTCreate a conversion/conversions
  • GETRetrieve statistics about this customer for a timeframe related to a subset of conversions grouped by some temporal entity (day/week/month)/conversions/aggregated/list?timeFrame=today&fromDay=string&toDay=string&status=deleted&groupBy=week
  • GETRetrieve a count of conversions/conversions/count?status=deleted&textSearch=string&createdAfter=string&createdBefore=string
  • GETRetrieve conversion specified by id/conversions/:conversionId
  • POSTUpdate conversion specified by id/conversions/:conversionId
  • DELETEDelete conversion specified by id/conversions/:conversionId
  • GETRetrieve statistics about this conversion for a timeframe/conversions/:conversionId/aggregated?timeFrame=today&fromDay=string&toDay=string&tag=string&favourite=true&hourly=true
  • GETRetrieve statistics about this conversion for a timeframe grouped by some temporal entity (day/week/month)/conversions/:conversionId/aggregated/list?timeFrame=today&fromDay=string&toDay=string&groupBy=week
  • GETRetrieve a list of datapoints connected to this conversion/conversions/:conversionId/datapoints?offset=0&limit=0&type=tp&status=deleted&tags=string&textSearch=string&createdAfter=string&createdBefore=string
  • PUTModify the association between a conversion and multiple datapoints/conversions/:conversionId/datapoints/batch/patch
  • GETRetrieve a count of datapoints connected to this conversion/conversions/:conversionId/datapoints/count?type=string&status=string&tags=string&textSearch=string&createdAfter=string&createdBefore=string
  • PUTModify the association between a conversion and a datapoint/conversions/:conversionId/datapoints/patch
  • GETRetrieve the list of events related to this conversion./conversions/:conversionId/hits?timeframe=yesterday&limit=0&offset=string&fromDay=string&toDay=string&filter=spiders
  • PUTFast patch the "notes" field of a conversion/conversions/:conversionId/notes

DataPoints

  • GETList of all the datapoints associated to the user/datapoints?offset=0&limit=20&type=tp&status=deleted&tags=string&textSearch=string&onlyFavorites=true&sortBy=string&sortDirection=asc&createdAfter=string&createdBefore=string
  • POSTCreate a datapoint/datapoints
  • GETRetrieve statistics about this customer for a timeframe by groups/datapoints/aggregated?timeFrame=today&type=tp&fromDay=string&toDay=string&hourly=true&status=deleted&tag=string&favourite=true
  • GETRetrieve statistics about all datapoints of this customer for a timeframe grouped by some temporal entity (day/week/month)/datapoints/aggregated/list?type=tp&timeFrame=today&fromDay=string&toDay=string&status=deleted&tag=string&favourite=true&groupBy=week
  • PUTCreate multiple datapoints/datapoints/batch
  • POSTUpdate multiple datapoints/datapoints/batch
  • DELETEDelete multiple datapoints/datapoints/batch
  • GETCount the datapoints associated to the user/datapoints/count?type=tp&status=deleted&tags=string&textSearch=string&onlyFavorites=true&createdAfter=string&createdBefore=string
  • GETGet a datapoint/datapoints/:id
  • POSTUpdate a datapoint/datapoints/:id
  • DELETEDelete a datapoint/datapoints/:id
  • GETRetrieve statistics about this datapoint for a timeframe/datapoints/:id/aggregated?timeFrame=today&fromDay=string&toDay=string&hourly=true
  • GETRetrieve statistics about this datapoint for a timeframe grouped by some temporal entity (day/week/month)/datapoints/:id/aggregated/list?timeFrame=today&fromDay=string&toDay=string&groupBy=week
  • PUTFast switch the "favourite" field of a datapoint/datapoints/:id/favourite
  • GETRetrieve the list of events related to this datapoint./datapoints/:id/hits?timeframe=yesterday&limit=0&offset=string&fromDay=string&toDay=string&filter=spiders
  • PUTFast patch the "notes" field of a datapoint/datapoints/:id/notes

Domains

  • GETRetrieve a list of domains/domains?offset=0&limit=0&type=system&name=string
  • POSTCreate a domain/domains
  • GETRetrieve count of domains/domains/count?type=system&name=string
  • GETGet a domain/domains/:id
  • POSTUpdate a domain/domains/:id
  • DELETEDelete a domain/domains/:id

Groups

  • GETList of all the groups associated to the user./groups?offset=0&limit=20&status=deleted&tags=string&textSearch=string&createdAfter=string&createdBefore=string&write=true
  • POSTCreate a group/groups
  • GETRetrieve statistics about this customer for a timeframe by groups/groups/aggregated?timeFrame=today&fromDay=string&toDay=string&hourly=true&status=deleted&tag=string&favourite=true
  • GETRetrieve statistics about all groups of this customer for a timeframe grouped by some temporal entity (day/week/month)/groups/aggregated/list?timeFrame=today&fromDay=string&toDay=string&status=string&tag=string&favourite=true&groupBy=deleted
  • GETCount the groups associated to the user./groups/count?status=deleted&tags=string&textSearch=string&createdAfter=string&createdBefore=string&write=true
  • GETGet a group/groups/:id
  • POSTUpdate a group/groups/:id
  • DELETEDelete group specified by id/groups/:id
  • GETRetrieve statistics about this group for a timeframe/groups/:id/aggregated?timeFrame=today&fromDay=string&toDay=string&hourly=true
  • GETRetrieve statistics about this group for a timeframe grouped by some temporal entity (day/week/month)/groups/:id/aggregated/list?timeFrame=today&fromDay=string&toDay=string&groupBy=week
  • GETRetrieve statistics about a subset of datapoints for a timeframe with datapoints data/groups/:id/aggregated/summary?timeFrame=today&type=tp&fromDay=string&toDay=string&status=deleted&tag=string&favourite=true&sortBy=string&sortDirection=asc&offset=0&limit=20&textSearch=string
  • GETList of all the datapoints associated to the user in this group./groups/:id/datapoints?offset=0&limit=20&type=tp&status=deleted&tags=string&textSearch=string&onlyFavorites=true&sortBy=string&sortDirection=asc&createdAfter=string&createdBefore=string
  • POSTCreate a datapoint in this group/groups/:id/datapoints
  • GETCount the datapoints associated to the user in this group./groups/:id/datapoints/count?type=tp&status=deleted&tags=string&textSearch=string&onlyFavorites=true&createdAfter=string&createdBefore=string
  • PUTFast switch the "favourite" field of a group/groups/:id/favourite
  • GETRetrieve the list of events related to this group./groups/:id/hits?timeframe=yesterday&limit=0&offset=string&fromDay=string&toDay=string&filter=spiders
  • PUTFast patch the "notes" field of a group/groups/:id/notes

Hits

  • GETRetrieve the list of events related to this account./hits?timeframe=yesterday&limit=0&offset=string&fromDay=string&toDay=string&filter=spiders

Me

  • GETRetrieve current account data/me
  • GETRetrieve current account plan/me/plan

Retargeting

  • GETList of all the retargeting scripts associated to the user/retargeting?offset=0&limit=20
  • POSTCreates a retargeting script/retargeting
  • GETRetrieve count of retargeting scripts/retargeting/count
  • GETGet a retargeting script object/retargeting/:id
  • POSTUpdates a retargeting script/retargeting/:id
  • DELETEDeletes a retargeting script (and remove associations)/retargeting/:id
  • GETList of all the datapoints associated to the retargeting script./retargeting/:id/datapoints?offset=0&limit=20&status=deleted&tags=string&textSearch=string&onlyFavorites=true&sortBy=string&sortDirection=asc&createdAfter=string&createdBefore=string
  • GETCount the datapoints associated to the retargeting script./retargeting/:id/datapoints/count?status=deleted&tags=string&textSearch=string&onlyFavorites=true&createdAfter=string&createdBefore=string

Tags

  • GETList of all the groups associated to the user filtered by this tag./tags?offset=0&limit=20&name=string&datapoints=string&groups=string&type=tp
  • POSTCreate a tag/tags
  • GETList of all the groups associated to the user filtered by this tag./tags/count?name=string&datapoints=string&groups=string&type=tp
  • GETRetrieve a tag/tags/:tagId
  • DELETEDelete a tag/tags/:tagId
  • GETList of all the datapoints associated to the user filtered by this tag/tags/:tagId/datapoints?offset=0&limit=20&type=tp&status=deleted&textSearch=string&createdAfter=string&createdBefore=string
  • DELETEDelete the association of this tag with all datapoints/tags/:tagId/datapoints
  • GETCount the datapoints associated to the user filtered by this tag/tags/:tagId/datapoints/count?type=tp&status=deleted&textSearch=string&createdAfter=string&createdBefore=string
  • PUTAssociate/Deassociate a tag with a datapoint/tags/:tagId/datapoints/patch
  • GETList of all the groups associated to the user filtered by this tag./tags/:tagId/groups?offset=0&limit=20&status=deleted&textSearch=string&createdAfter=string&createdBefore=string
  • DELETEDelete the association of this tag with all groups/tags/:tagId/groups
  • GETCount the groups associated to the user filtered by this tag/tags/:tagId/groups/count?status=deleted&textSearch=string&createdAfter=string&createdBefore=string
  • PUTAssociate/Deassociate a tag with a group/tags/:tagId/groups/patch
  • PUTFast patch a tag name/tags/:tagId/name

API details

Base URL
http://apiv2.clickmeter.com:80
https://apiv2.clickmeter.com:80
Authentication
An API key in the X-Clickmeter-AuthKey header
Operations
104 operations on 75 pathsGET 61POST 19PUT 12DELETE 12
Main resources
Account 19Groups 17DataPoints 16Conversions 15Tags 14Retargeting 8Domains 6Aggregated 5Me 2ClickStream 1
Response formats
application/json text/json application/xml
Description format
OpenAPI 3.0.0, API version v2
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the ClickMeter API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the ClickMeter API collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Clickmeter-AuthKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Retrieve current account data” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the ClickMeter API?

Api dashboard for ClickMeter API It is listed under Other and has 104 endpoints.

Who publishes the ClickMeter API?

It is listed from Clickmeter's public API description (an OpenAPI document), not published by Clickmeter on Swastik Codes. Anyone who controls clickmeter.com can claim the profile by adding a DNS TXT record.

What is the base URL of the ClickMeter API?

Its description lists 2 base URLs: http://apiv2.clickmeter.com:80, https://apiv2.clickmeter.com:80. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the ClickMeter API?

With an API key in the X-Clickmeter-AuthKey header.

How many endpoints does the ClickMeter API have?

104 operations on 75 paths (61 GET, 19 POST, 12 PUT, 12 DELETE). The largest groups are Account, Groups, DataPoints, Conversions.

Is forking the ClickMeter API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.