Model
A domain is an entity representing the initial part of the URL of your tracking links. They are used to generate your tracking links and thus an integral part of them. By default ClickMeter offers some standard domains to be used but you can add your owns through this API. Some fields are maked as optional as in they don’t need to be present in a minimum working domain.
GET /domains
Retrieve a list of domains associated to the current authenticated user.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: EntityURIList (see “Common models”)
Filters:
-
offset [optional] [integer, 0] : Where to start when retrieving domains
-
limit [optional] [integer, 20] : Maximum elements to retrieve
-
name[optional] [string, all] : A pattern name expression. Example: twit*
-
type [optional] [string, system] : Type of the domain, possible types are system, dedicated, go, and personal
GET /domains/count
Retrieve a count of the domains associated to the current authenticated user.
This endpoint has optional filters that can be used in the GET request to change its response behaviour.
Result: CountObject (see “Common models”)
Filters:
-
name[optional] [string, all] : A pattern name expression. Example: twit*
-
type [optional] [string, system] : Type of the domain, possible types are system, dedicated, go, and personal
POST /domains
Create a domain for the current authenticated user.
Input: Domain (one without id)
Result: EntityURI (uri of the newly created domain)
GET /domains/{id}
Retrieve the domain {id} for the current authenticated user.
Result: Domain
DELETE /domains/{id}
Delete the domain {id} for the current authenticated user.
Result: EntityURI
POST /domains/{id}
Update the domain {id} for the current authenticated user.
Input: Domain (the one you fetched from GET /domains/{id} with your modifications)
Result: EntityURI
For more info read this FAQ:
0 Comments