Skip to content

Get counters listing

Returns an array of counter names for a pattern

Method:

GET

Endpoint URL

The xxxx.backendless.app is a subdomain assigned to your application. For more information see the Client-side Setup section of this documentation.

https://xxxx.backendless.app/api/counters/<counterNamePattern>/list

where:

Argument                Description
<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

Make sure to replace xxxx in the domain name in the sample request below to the one assigned to your application.

Request:

GET https://xxxx.backendless.app/api/counters/shopper?/list

Response:

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

Codeless Reference

codeless_atomic_counters_get_counters_list

where:

Argument                Description
name pattern 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

Returns a list containing counter names.

Consider the following counter names:

codeless_atomic_counters_get_counters_list_2

The example below retrieves all counters since the glob pattern is set to * (all names).

codeless_atomic_counters_get_counters_list_3

The result of this operation will look as shown below after the Codeless logic runs:

codeless_atomic_counters_get_counters_list_4