Skip to content

Get counters listing

Returns an array of counter names for a pattern

Method:

GET

URL

https://api.backendless.com/<application-id>/<REST-api-key>/counters/<counterNamePattern>/list

where:

Argument                Description
<application id> ID of the application which can be obtained from the Manage > App Settings screen of the Backendless Console
<REST-api-key> REST API key of your application. You can get the value from the Manage > App Settings section of the Backendless Console.
<counterNamePattern> counter name pattern. You can use the glob-style patterns. For example:
* matches all counter names;
h?llo matches hello, hallo and hxllo
h*llo matches hllo and heeeello
h[ae]llo matches hello and hallo, but not hillo
h[^e]llo matches hallo, hbllo, ... but not hello
h[a-b]llo matches hallo and hbllo

Request headers

user-token: optional value obtained as a result of the login operation.

where:

Argument                Description
user-token Optional header. Contains a value returned by Backendless in a preceding user Login API call. The operation will be executed with the security policy associated currently logged in user. This means all permissions associated with the user and the roles assigned to the user will be enforced by Backendless.

Request body

N/A

Response body

A JSON array of matching counter names. If no names match, the response is an empty array.

Example

Request

GET https://api.backendless.com/XXXX-XXXX-XXXX/ZZZZ-ZZZZ-ZZZZ/counters/shopper?/list

Response:

[
 "shopper1",
 "shopper2",
 "shopper3",
 "shopper4",
 "shopper5"
]