Datapoint Categories
- Nina Cardillo
Analytics
Datapoint categories are optional tags that can be used for filtering datapoint lists. For example, a set of datapoints to be monitored in a web page can be tagged with a unique category tag, and then all the datapoints for the page can be fetched with a single request specifying the unique category filter.
URI Definition
Method | URI and Fields |
GET | /iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/cat |
Returns the categories assigned to the specified datapoints. XIFname vs Instance Name
Path ParametersThe optional path parameters for the id , block, block_index, and datapoint_name path elements are listed on the Path Parameters page. | |
PUT | /iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/cat |
Adds one or multiple categories to a datapoint. The categories to be added are specified in the request data. Any categories that have already been added to the datapoint are ignored. XIFname vs Instance Name
Path ParametersThe optional path parameters for the id , block, block_index, and datapoint_name path elements are listed on the Path Parameters page. | |
DELETE | /iap/devs/{id}/if/{block}/{block_index}/{datapoint_name}/cat |
Deletes one or multiple categories from a datapoint. The categories to be deleted are specified in the request data. XIFname vs Instance Name
Path ParametersThe optional path parameters for the id , block, block_index, and datapoint_name path elements are listed on the Path Parameters page. |
Queries
You can include queries with your IAP/REST request to specify a selection rule for your request. As described in Queries and Parameters, you can specify a query as a query parameter appended to the end of your URI preceded with a "?" character, or as a path parameter within a path element of the URI.
The optional path parameters for the id , block, block_index, and datapoint_name path elements are listed on the Path Parameters page.