{"__v":2,"_id":"55fcb5a156d6990d00a6ca28","category":{"__v":0,"_id":"56394a0c3539050d00082122","pages":[],"project":"5553d36165e8260d0024419a","version":"55fc9b793c21291900e7e0d7","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-11-03T23:58:04.263Z","from_sync":false,"order":14,"slug":"api-api-calls","title":"API: API Calls"},"parentDoc":null,"project":"5553d36165e8260d0024419a","user":"5553d33065e8260d00244199","version":{"__v":12,"_id":"55fc9b793c21291900e7e0d7","project":"5553d36165e8260d0024419a","createdAt":"2015-09-18T23:17:13.545Z","releaseDate":"2015-09-18T23:17:13.545Z","categories":["55fc9b7a3c21291900e7e0d8","55fc9b7a3c21291900e7e0d9","55fc9b7a3c21291900e7e0da","55fc9b7a3c21291900e7e0db","55fc9b7a3c21291900e7e0dc","55fc9b7a3c21291900e7e0dd","55fc9b7a3c21291900e7e0de","55fc9b7a3c21291900e7e0df","55fc9b7a3c21291900e7e0e0","55fc9b7a3c21291900e7e0e1","55fc9b7a3c21291900e7e0e2","55fc9b7a3c21291900e7e0e3","55fc9bad4c80910d00b9bece","56394a0c3539050d00082122","56394a2f68b11f0d0048c9ff","56394a462fc5520d001a4db3","56394a4c2fc5520d001a4db4","56394a5b049e420d00476b5c","56394a6a2fc5520d001a4db5","56394f791593e4190073a44b","567b3adfb56bac0d0019d8d9","569d590e5a2b060d008741eb","569ea93dffccd10d00a05c7f"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-09-19T01:08:49.183Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"The API Call object defines the HTTP request that we make from a Deployment. The request can have an Authentication Setting and Authentication Token applied to it.\nExample object:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n  \\\"access\\\": {\\n    \\\"org\\\": false, \\n    \\\"stats\\\": false, \\n    \\\"results\\\": false, \\n    \\\"settings\\\": false\\n  }, \\n  \\\"meta\\\": {\\n    \\\"domain\\\": \\\"httpbin.org\\\", \\n    \\\"description\\\": null, \\n    \\\"created\\\": \\\"2015-09-18T23:29:39.534120Z\\\", \\n    \\\"tags\\\": [], \\n    \\\"accept\\\": null, \\n    \\\"last_update\\\": \\\"2015-09-18T23:29:39.534173Z\\\", \\n    \\\"content_type\\\": null, \\n    \\\"owner\\\": \\\"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\\\", \\n    \\\"name\\\": \\\"Minimal API test name\\\"\\n  }, \\n  \\\"request\\\": {\\n    \\\"body\\\": null, \\n    \\\"parameters\\\": [], \\n    \\\"url\\\": \\\"http://httpbin.org/get\\\", \\n    \\\"auth_id\\\": null, \\n    \\\"headers\\\": [], \\n    \\\"token_id\\\": null, \\n    \\\"method\\\": \\\"GET\\\"\\n  }, \\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"meta\",\n    \"0-1\": \"See below\",\n    \"0-2\": \"Y\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"1-0\": \"access\",\n    \"1-1\": \"See below\",\n    \"1-2\": \"N\",\n    \"2-0\": \"request\",\n    \"2-1\": \"See below\",\n    \"2-2\": \"Y\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"meta\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"name\",\n    \"0-1\": \"Name of call for your reference\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"Yes\",\n    \"1-0\": \"description\",\n    \"1-1\": \"Description of call for your reference\",\n    \"1-2\": \"No\",\n    \"2-0\": \"tags\",\n    \"2-1\": \"List of tags for the call for your reference\",\n    \"2-2\": \"No\",\n    \"3-0\": \"owner\",\n    \"3-1\": \"ID of owner of Call\",\n    \"3-2\": \"No - readonly\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"access\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"settings\",\n    \"1-0\": \"results\",\n    \"2-0\": \"stats\",\n    \"3-0\": \"org\",\n    \"3-1\": \"Can other users in your organization view the API Call and it's stats and results?\",\n    \"0-1\": \"Is the call shared with the APImetrics community?\",\n    \"1-1\": \"Is the call's results shared with the APImetrics community?\",\n    \"2-1\": \"Is the call's stats shared with the APImetrics community?\",\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-2\": \"N\",\n    \"1-2\": \"N\",\n    \"2-2\": \"N\",\n    \"3-2\": \"N\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"request\"\n}\n[/block]\n\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Name\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Required?\",\n    \"0-0\": \"method\",\n    \"0-1\": \"HTTP method to use\",\n    \"0-2\": \"Y\",\n    \"1-0\": \"url\",\n    \"1-1\": \"URL to call\",\n    \"1-2\": \"Y\",\n    \"2-0\": \"parameters\",\n    \"2-1\": \"List of request parameters to append to call\",\n    \"2-2\": \"N\",\n    \"3-0\": \"headers\",\n    \"3-1\": \"List of headers to include in call\",\n    \"3-2\": \"N\",\n    \"4-0\": \"body\",\n    \"4-1\": \"Content of POST or PUT call\",\n    \"4-2\": \"N\",\n    \"5-0\": \"auth_id\",\n    \"5-1\": \"ID of authentication settings to use\",\n    \"5-2\": \"N\",\n    \"6-0\": \"token_id\",\n    \"6-1\": \"ID of token to use with authentication settings\",\n    \"6-2\": \"N\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]","excerpt":"Description of the JSON that describes an API Call","slug":"call-object","type":"basic","title":"Call Object"}

Call Object

Description of the JSON that describes an API Call

The API Call object defines the HTTP request that we make from a Deployment. The request can have an Authentication Setting and Authentication Token applied to it. Example object: [block:code] { "codes": [ { "code": "{\n \"access\": {\n \"org\": false, \n \"stats\": false, \n \"results\": false, \n \"settings\": false\n }, \n \"meta\": {\n \"domain\": \"httpbin.org\", \n \"description\": null, \n \"created\": \"2015-09-18T23:29:39.534120Z\", \n \"tags\": [], \n \"accept\": null, \n \"last_update\": \"2015-09-18T23:29:39.534173Z\", \n \"content_type\": null, \n \"owner\": \"agxkZXZ-dmlhdGVzdHNyEQsSBFVzZXIYgICAgICAgAoM\", \n \"name\": \"Minimal API test name\"\n }, \n \"request\": {\n \"body\": null, \n \"parameters\": [], \n \"url\": \"http://httpbin.org/get\", \n \"auth_id\": null, \n \"headers\": [], \n \"token_id\": null, \n \"method\": \"GET\"\n }, \n}", "language": "json" } ] } [/block] [block:parameters] { "data": { "0-0": "meta", "0-1": "See below", "0-2": "Y", "h-0": "Name", "h-1": "Description", "h-2": "Required?", "1-0": "access", "1-1": "See below", "1-2": "N", "2-0": "request", "2-1": "See below", "2-2": "Y" }, "cols": 3, "rows": 3 } [/block] [block:api-header] { "type": "basic", "title": "meta" } [/block] [block:parameters] { "data": { "0-0": "name", "0-1": "Name of call for your reference", "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-2": "Yes", "1-0": "description", "1-1": "Description of call for your reference", "1-2": "No", "2-0": "tags", "2-1": "List of tags for the call for your reference", "2-2": "No", "3-0": "owner", "3-1": "ID of owner of Call", "3-2": "No - readonly" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "access" } [/block] [block:parameters] { "data": { "0-0": "settings", "1-0": "results", "2-0": "stats", "3-0": "org", "3-1": "Can other users in your organization view the API Call and it's stats and results?", "0-1": "Is the call shared with the APImetrics community?", "1-1": "Is the call's results shared with the APImetrics community?", "2-1": "Is the call's stats shared with the APImetrics community?", "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-2": "N", "1-2": "N", "2-2": "N", "3-2": "N" }, "cols": 3, "rows": 4 } [/block] [block:api-header] { "type": "basic", "title": "request" } [/block] [block:parameters] { "data": { "h-0": "Name", "h-1": "Description", "h-2": "Required?", "0-0": "method", "0-1": "HTTP method to use", "0-2": "Y", "1-0": "url", "1-1": "URL to call", "1-2": "Y", "2-0": "parameters", "2-1": "List of request parameters to append to call", "2-2": "N", "3-0": "headers", "3-1": "List of headers to include in call", "3-2": "N", "4-0": "body", "4-1": "Content of POST or PUT call", "4-2": "N", "5-0": "auth_id", "5-1": "ID of authentication settings to use", "5-2": "N", "6-0": "token_id", "6-1": "ID of token to use with authentication settings", "6-2": "N" }, "cols": 3, "rows": 7 } [/block]