{"_id":"56afd736b34d210d003d9ba9","editedParams2":true,"githubsync":"","user":"56acd6caa040860d00ac94a2","version":{"_id":"56acd71213ac890d001c3c7d","project":"56acd71213ac890d001c3c7a","__v":15,"createdAt":"2016-01-30T15:30:26.928Z","releaseDate":"2016-01-30T15:30:26.928Z","categories":["56acd71313ac890d001c3c7e","56acd8f113ac890d001c3c81","56acd8f95ac4060d0027865e","56acd93a13ac890d001c3c82","56ad20660ab3c00d00ce3347","56ad356a2a7860170013f714","56ad47eb0ab3c00d00ce334f","56afd523bc304a0d00ace1df","56b29a019621f20d00efb37e","56b657e11bc6970d009feee7","5845cc3c39950c1b002afe77","5845cde163c11b250037967e","5846efd45d064323007b17b4","588604da4674e32300efd160","588627882393d50f00f1322c"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"editedParams":true,"project":"56acd71213ac890d001c3c7a","parentDoc":null,"__v":3,"category":{"_id":"56afd523bc304a0d00ace1df","pages":["56afd736b34d210d003d9ba9","56afd977bc304a0d00ace1e3","56b0e385135ec20d00baf9a9"],"project":"56acd71213ac890d001c3c7a","__v":3,"version":"56acd71213ac890d001c3c7d","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2016-02-01T21:58:59.198Z","from_sync":false,"order":4,"slug":"channel-resource","title":"Channel Resource"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-02-01T22:07:50.863Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"var params = {\n\taccess_token: \"CHANNEL_ACCESS_TOKEN\",\n  include: \"twitch,youtube,sponsor_counts\"\n};\n\n$.getJSON('https://api.gamewisp.com/pub/v1/channel/information/', params, function(json) {\n    console.log(json);\n});","language":"javascript"},{"language":"php","code":"<?php\n\n$client = new GuzzleHttp\\Client();\n\ntry {\n\n  $response = $client->get('https://api.gamewisp.com/pub/v1/channel/information', [\n    'query' => [\n      'access_token'  => 'CHANNEL_ACCESS_TOKEN',\n      'include' => 'twitch,youtube,sponsor_counts'\n    ]\n  ]);\n\n  $result = $response->json();\n\n} catch (Exception $e) {\n\n  //error\n  $result = $e->getResponse()->json();\n\n}"},{"code":"https://api.gamewisp.com/pub/v1/channel/information?access_token=CHANNEL_ACCESS_TOKEN&include=twitch,youtube,sponsor_counts","language":"text","name":"Sample URL"}]},"method":"get","results":{"codes":[{"name":"","code":"{\n  \"result\": {\n    \"status\": 1,\n    \"message\": \"Channel Retrieved\"\n  },\n  \"data\": {\n    \"id\": 2,\n    \"display_name\": \"Channel Name\",\n    \"owner_user_id\": 5,\n    \"blurb\": \"\",\n    \"name\": \"channelname\",\n    \"deactivated\": false,\n    \"description\": \"Channel description\",\n    \"links\": {\n      \"rel\": \"self\",\n      \"uri\": \"/channel/dev2\"\n    },\n    \"twitch\": {\n      \"data\": {\n        \"twitch_id\": \"12345\",\n        \"name\": \"test\",\n        \"display_name\": \"test\",\n        \"url\": \"https://twitch.tv/test\",\n        \"partnered\": false\n      }\n    },\n    \"youtube\": {\n      \"data\": {\n        \"youtube_id\": \"asdf3adfsd\",\n        \"user_name\": \"test\",\n        \"title\": \"Test channel\",\n        \"url\": \"https://youtube.com/user/test\"\n      }\n    },\n    \"sponsor_counts\": {\n      \"data\": {\n        \"active\": 5,\n        \"trial\": 2,\n        \"grace_period\": 1,\n        \"inactive\": 4,\n        \"twitch\": 0,\n        \"billing_grace_period\": 1\n      }\n    }\n  }\n}","language":"json","status":200}]},"settings":"","auth":"required","params":[{"_id":"56afd736b34d210d003d9baa","ref":"","in":"query","required":true,"desc":"The OAuth2 access token of the channel.","default":"","type":"string","name":"access_token"},{"_id":"56b141baf48f270d00e0dd86","ref":"","in":"query","required":true,"desc":"the read_only scope is required, and supplied by default.","default":"read_only","type":"string","name":"scope"},{"_id":"56b147656d004b17008066ad","ref":"","in":"query","required":false,"desc":"Optional parameters to access more information. See \"Include Parameters\" below.","default":"","type":"string","name":"include"}],"url":"/channel/information"},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"This endpoint Accepts Include Parameters\",\n  \"body\": \"Be sure to review [how include parameters work](https://gamewisp.readme.io/docs/additional-includes) if you haven't yet.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Include Parameters\"\n}\n[/block]\nThe parameters below can also be included in any combination as a comma separated list (e.g, ```include=twitch,youtube``` in the query string).\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Include Parameter\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"twitch\",\n    \"0-1\": \"Return the basic Twitch information linked to the GameWisp channel if it exists.\",\n    \"1-0\": \"youtube\",\n    \"1-1\": \"Return the basic YouTube information linked to the GameWisp channel if it exists.\",\n    \"2-0\": \"tiers\",\n    \"2-1\": \"Return the channel's tiers\",\n    \"3-0\": \"sponsor_counts\",\n    \"3-1\": \"Return the number of subscribers for each sponsor status type\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]","excerpt":"","slug":"channelinformation","type":"endpoint","title":"/channel/information"}

get/channel/information


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

access_token:
required
string
The OAuth2 access token of the channel.
scope:
required
stringread_only
the read_only scope is required, and supplied by default.
include:
string
Optional parameters to access more information. See "Include Parameters" below.

Examples


Result Format


Documentation

[block:callout] { "type": "info", "title": "This endpoint Accepts Include Parameters", "body": "Be sure to review [how include parameters work](https://gamewisp.readme.io/docs/additional-includes) if you haven't yet." } [/block] [block:api-header] { "type": "basic", "title": "Include Parameters" } [/block] The parameters below can also be included in any combination as a comma separated list (e.g, ```include=twitch,youtube``` in the query string). [block:parameters] { "data": { "h-0": "Include Parameter", "h-1": "Description", "0-0": "twitch", "0-1": "Return the basic Twitch information linked to the GameWisp channel if it exists.", "1-0": "youtube", "1-1": "Return the basic YouTube information linked to the GameWisp channel if it exists.", "2-0": "tiers", "2-1": "Return the channel's tiers", "3-0": "sponsor_counts", "3-1": "Return the number of subscribers for each sponsor status type" }, "cols": 2, "rows": 4 } [/block]