{"_id":"563a2dbc1846790d00895315","category":{"_id":"563a2dbb1846790d0089530a","__v":3,"pages":["563a2dbc1846790d0089530f","563a2dbc1846790d00895310","563a2dbc1846790d00895311","563a2dbc1846790d00895312","563a2dbc1846790d00895313","563a2dbc1846790d00895314","563a2dbc1846790d00895315","563a2dbc1846790d00895316","563a2dbc1846790d00895317","566232310299ea0d008f2cf2","56623a2d0299ea0d008f2cf6"],"project":"54d4ecb5f6c48a0d00f0f041","version":"563a2dba1846790d00895309","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-02-06T16:32:54.503Z","from_sync":false,"order":2,"slug":"documentation","title":"Documentation"},"project":"54d4ecb5f6c48a0d00f0f041","user":"54d4ec36f6c48a0d00f0f040","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,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-26T11:17:42.901Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":7,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Resource Meta Data\"\n}\n[/block]\nEvery representation of an Instacount resource will contain a sub-object called **meta**, which will contain information about a resource.  Note that information contained inside of meta objects is not actually part of the resource's data, but is instead data *about* the resource.  \n\nExamples of meta-data include links to related resources, derived data, data from other resources, and other information that might help inform the resource.\n\nFor example, the sharded counter resource representation has the following meta that contains links to other resources related to the counter:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"meta\\\":{\\n  \\n    \\\":::at:::self\\\": {\\n      \\\"href\\\": \\\"https://api.instacount.io/sharded_counters/counter-abc\\\"\\n    },\\n  \\n    \\\"@increments\\\":{\\n      \\\"href\\\": \\\"https://api.instacount.io/sharded_counters/counter-abc/increments\\\"\\n    },\\n  \\n    \\\"@decrements\\\":{\\n      \\\"href\\\": \\\"https://api.instacount.io/sharded_counters/counter-abc/decrements\\\"\\n    }\\n    \\n  }\\n  ...\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Example Meta Information\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Links\"\n}\n[/block]\nOne special type of meta-data that is present in all resource representations is **link** data.  Links are meant to provide pointers to related resources so that proper API clients don’t need to construct URLs on their own.  \n\nLink names will always start with an at-sign (@).\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"body\": \"It is highly recommended that API clients use any supplied meta links instead of assembling URLs to Instacount resources. Doing so will make consuming future upgrades of the API much easier.\",\n  \"title\": \"Don't Assemble URLs on the Client\"\n}\n[/block]","excerpt":"","slug":"hypermedia","type":"basic","title":"Hypermedia"}
[block:api-header] { "type": "basic", "title": "Resource Meta Data" } [/block] Every representation of an Instacount resource will contain a sub-object called **meta**, which will contain information about a resource. Note that information contained inside of meta objects is not actually part of the resource's data, but is instead data *about* the resource. Examples of meta-data include links to related resources, derived data, data from other resources, and other information that might help inform the resource. For example, the sharded counter resource representation has the following meta that contains links to other resources related to the counter: [block:code] { "codes": [ { "code": "{\n \"meta\":{\n \n \"@self\": {\n \"href\": \"https://api.instacount.io/sharded_counters/counter-abc\"\n },\n \n \"@increments\":{\n \"href\": \"https://api.instacount.io/sharded_counters/counter-abc/increments\"\n },\n \n \"@decrements\":{\n \"href\": \"https://api.instacount.io/sharded_counters/counter-abc/decrements\"\n }\n \n }\n ...\n}", "language": "json", "name": "Example Meta Information" } ] } [/block] [block:api-header] { "type": "basic", "title": "Links" } [/block] One special type of meta-data that is present in all resource representations is **link** data. Links are meant to provide pointers to related resources so that proper API clients don’t need to construct URLs on their own. Link names will always start with an at-sign (@). [block:callout] { "type": "danger", "body": "It is highly recommended that API clients use any supplied meta links instead of assembling URLs to Instacount resources. Doing so will make consuming future upgrades of the API much easier.", "title": "Don't Assemble URLs on the Client" } [/block]