{"_id":"563a2dbd1846790d00895319","version":{"_id":"563a2dba1846790d00895309","__v":3,"project":"54d4ecb5f6c48a0d00f0f041","createdAt":"2015-11-04T16:09:30.844Z","releaseDate":"2015-11-04T16:09:30.844Z","categories":["563a2dbb1846790d0089530a","563a2dbb1846790d0089530b","563a2dbb1846790d0089530c","56620e60f183880d004d3217","5702e5b8f2d6f336005e9025"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"No Mashape","version_clean":"1.1.0","version":"1.1"},"__v":0,"user":"54d4ec36f6c48a0d00f0f040","editedParams":true,"editedParams2":true,"category":{"_id":"563a2dbb1846790d0089530b","project":"54d4ecb5f6c48a0d00f0f041","pages":["563a2dbd1846790d00895318","563a2dbd1846790d00895319","563a2dbd1846790d0089531a","563a2dbd1846790d0089531b","563a2dbd1846790d0089531c","563a2dbd1846790d0089531d","563a2dbd1846790d0089531e"],"version":"563a2dba1846790d00895309","__v":1,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-06T16:37:55.318Z","from_sync":false,"order":3,"slug":"endpoints","title":"API Endpoints"},"project":"54d4ecb5f6c48a0d00f0f041","updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-04-06T23:09:08.702Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"","language":"text"}]},"method":"get","results":{"codes":[{"name":"OK","status":200,"language":"json","code":"{\n  \"meta\": {\n    \":::at:::self\": {\n    \t\"href\": \"https://api.instacount.io/sharded_counters/num-followers-abc\"\n    },\n    \"@increment\": {\n    \t\"href\": \"https://api.instacount.io/sharded_counters/num-followers-abc/increments\"\n    },\n    \"@decrement\": {\n    \t\"href\": \"https://api.instacount.io/sharded_counters/num-followers-abc/decrements\"\n    }\n  },\n  \"name\": \"num-followers-abc\",\n  \"description\": \"The number of followers for user abc\",\n  \"numShards\": 3,\n  \"status\": \"AVAILABLE\",\n  \"count\": 13,\n  \"created\": \"2015-08-24T22:45:13.985Z\"\n}"},{"language":"json","status":401,"code":"{\n  \"errors\": [\n    {\n      \"message\": \"You must be signed-in to access the information you requested.\",\n      \"developer_message\": \"You must enable proper Instacount Authentication!  Invalid X-Instacount-API-Key Header!\",\n      \"more_info\": \"https://instacount.readme.io\"\n    }\n  ]\n}"},{"code":"{\n  \"errors\": [\n    {\n      \"message\": \"What you requested does not exist.\",\n      \"developer_message\": \"The resource you requests was not found!\",\n      \"more_info\": \"https://instacount.readme.io\"\n    }\n  ]\n}","language":"json","status":404}]},"settings":"","auth":"required","params":[{"_id":"55231031dbe3622300a324b6","ref":"","in":"query","required":true,"desc":"A unique name that identifies the counter.","default":"num-followers-abc","type":"string","name":"name"}],"url":"/sharded_counters/:counterName"},"isReference":false,"order":1,"body":"The counter representation has the following fields:\n\n* **meta:** An object that contains meta-data about this resource, including links to related resources.\n* **name:** The unique name of the counter.  This value is limited to 500 UTF-16 Unicode characters.\n* **description:** A description for the counter.  This value is limited to 500 UTF-16 Unicode characters.\n* **status:** The current status of the counter.\n  * **AVAILABLE:** The counter is available to be read and/or mutated.\n  * **READ_ONLY:** The counter is available to be read, but may not be updated, incremented, nor decremented.\n  * **EXPANDING_SHARDS:** The Counter is expanding the number of shards it holds internally, and may not be incremented, decremented, updated, nor deleted.\n  * **CONTRACTING_SHARDS: ** The Counter is contracting the number of shards it holds internally, and may not be incremented, decremented, updated, nor deleted.\n  * **RESETTING: ** The Counter is in the process of having all shard amounts set to zero, and may not be incremented or decremented.\n  * **DELETING: ** The counter is in the process of being deleted, and may not be incremented, decremented nor have any of its details updated.\n[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Counter Statuses\",\n  \"body\": \"External clients may set a counter into the **AVAILABLE** or **READ_ONLY** state by updating the counter itself.  However, a counter may only enter one of the other states indirectly, for example after changing the number of shards in a given counter.\"\n}\n[/block]","excerpt":"Get a counter by name","slug":"shardedcountersname","type":"endpoint","title":"Get a Counter"}

getGet a Counter

Get a counter by name

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

name:
required
stringnum-followers-abc
A unique name that identifies the counter.

Result Format


Documentation

The counter representation has the following fields: * **meta:** An object that contains meta-data about this resource, including links to related resources. * **name:** The unique name of the counter. This value is limited to 500 UTF-16 Unicode characters. * **description:** A description for the counter. This value is limited to 500 UTF-16 Unicode characters. * **status:** The current status of the counter. * **AVAILABLE:** The counter is available to be read and/or mutated. * **READ_ONLY:** The counter is available to be read, but may not be updated, incremented, nor decremented. * **EXPANDING_SHARDS:** The Counter is expanding the number of shards it holds internally, and may not be incremented, decremented, updated, nor deleted. * **CONTRACTING_SHARDS: ** The Counter is contracting the number of shards it holds internally, and may not be incremented, decremented, updated, nor deleted. * **RESETTING: ** The Counter is in the process of having all shard amounts set to zero, and may not be incremented or decremented. * **DELETING: ** The counter is in the process of being deleted, and may not be incremented, decremented nor have any of its details updated. [block:callout] { "type": "warning", "title": "Counter Statuses", "body": "External clients may set a counter into the **AVAILABLE** or **READ_ONLY** state by updating the counter itself. However, a counter may only enter one of the other states indirectly, for example after changing the number of shards in a given counter." } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}