{"info":{"_postman_id":"4d154deb-0fc3-413e-8ab0-702d012f0fb1","name":"SENG3011 Team Unassigned Facebook API","description":"

Introduction

This API allows querying for Facebook post and company page information.

Usage

Responses to all requests will be in the following format:

{\n    data: Optional (depending on the response code),\n    dev_team: 'Team Unassigned',\n    version: version number,\n    start_time: ISO date,\n    end_time: ISO date,\n    time_elapsed: duration in milliseconds,\n    params: The URL parameters,\n    status: HTTP response code,\n    status_text: Description of the response, including any error messages\n}\n

Error Codes

All responses will return with a status code of either 200 (OK) or 400 (BAD REQUEST), and will be accompanied by a status_text description.

Parameters

All queries must have at least one parameter, access_token, specified. This is necessary since the Facebook Graph API used internally currently requires a temporary API token to access it. To obtain a valid API token from Facebook, visit https://developers.facebook.com/tools/explorer/ and select Get Token -> Get User Access Token -> Get Access Token.

API Version

The latest version of the API can be accessed at https://unassigned-api.herokuapp.com/api

For old versions, use URLs of the form\nhttps://unassigned-api.herokuapp.com/api/v1,\nhttps://unassigned-api.herokuapp.com/api/v2, etc

The current version is v3.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Introduction","slug":"introduction"},{"content":"Usage","slug":"usage"},{"content":"Error Codes","slug":"error-codes"},{"content":"Parameters","slug":"parameters"},{"content":"API Version","slug":"api-version"}],"owner":"3928503","collectionId":"4d154deb-0fc3-413e-8ab0-702d012f0fb1","publishedId":"RVtyoBYu","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2018-04-27T05:25:14.000Z"},"item":[{"name":"/api/:company","event":[{"listen":"test","script":{"id":"5498341a-aed8-40ed-a861-3003f1418e01","type":"text/javascript","exec":[""]}}],"id":"571904d8-3389-4235-a624-f4d29f21311e","request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://unassigned-api.herokuapp.com/api/facebook","description":"

This endpoint serves to pull information pertaining to a Facebook page. The :company parameter can be any of:

Facebook page ID
Company name
Company stock code

For example, valid company names would be \"medibank\" and \"woolworths\". Their corresponding page IDs and stock codes are 337166469633637, 147632815308858 and \"MPL.ax\" and \"WOW.ax\". Note that the \".ax\" suffix is completely optional.

Here are some examples of companies supported by the API (by stock code): \"SUN”, “AMP”, “MPL”, ”MQG”, “ANZ”, “NAB”, “WOW”, “CBA”, “WBC”, “TLS\" and \"FB\".

A user can specify the fields relating to a page by passing them as a comma separated list of values through the statistics parameter.

If no statistics are supplied, it will default to:

id - Facebook page ID
name
website
description
category
fan_count - number of likes on the page
posts - a list of posts on the page

Example query:

GET /api/woolworths?statistics=name,category,fan_count&access_token=<...>

Example response:

{\n    \"data\": {\n        \"name\": \"Woolworths\",\n        \"category\": \"Retail Company\",\n        \"fan_count\": 1057423,\n        \"id\": \"147632815308858\"\n    },\n    \"dev_team\": \"Team Unassigned\",\n    \"version\": \"1.0.0\",\n    \"start_time\": \"2018-03-30T00:52:33.852Z\",\n    \"end_time\": \"2018-03-30T00:54:20.629Z\",\n    \"time_elapsed\": 106777,\n    \"params\": {\n        \"statistics\": \"name,category,fan_count\"\n    },\n    \"status\": 200,\n    \"status_text\": \"OK\"\n}\n

If the supplied statistics includes posts (implying that the user would like to pull posts made by the page), then two additional parameters can be supplied:

start_date
end_date

Both must be in ISO 8601 format (YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.sssZ) and will serve as a range for the posts returned.

If neither is supplied, the most recent posts will be returned by default. If only start_date is supplied, only posts after that date will be returned. If only end_date is supplied, only posts before that date will be returned.

Example query:

GET /api/woolworths?statistics=posts&start_date=2015-10-01T08:45:10.295Z&end_date=2015-11-01T19:37:12.193Z&access_token=<...>

Example response:

{\n    \"data\": {\n        \"posts\": {\n            \"data\": [\n                {\n                    \"message\": \"We’re currently taking a little break celebrating Easter, but we’ll be back on the 31st of March from 9am. For any urgent product safety issues please call 1800 638 434.\\n\\nYou can check opening times of your local store through Store Locator on our website.\\n\\nWe wish you all a very happy Easter. \\nhttps://www.woolworths.com.au/\",\n                    \"created_time\": \"2018-03-29T20:00:01+0000\",\n                    \"id\": \"147632815308858_1958529244219197\"\n                },\n                {\n                    \"message\": \"Would you say yes? 🤷🥑💍\",\n                    \"created_time\": \"2018-03-23T03:05:28+0000\",\n                    \"id\": \"147632815308858_10155253208306587\"\n                },\n                {\n                    \"message\": \"If tomatoes are classified as a fruit... isn't tomato sauce technically a smoothie? 🍅🤔\",\n                    \"created_time\": \"2018-03-12T04:00:00+0000\",\n                    \"id\": \"147632815308858_1952459951492793\"\n                },\n                {\n                    \"message\": \"You have 30 seconds...GO! 😂\",\n                    \"created_time\": \"2018-03-06T22:30:00+0000\",\n                    \"id\": \"147632815308858_1943386495733472\"\n                }\n                ... more posts here\n            ],\n        },\n        \"id\": \"147632815308858\"\n    }\n}\n

Nested Querying:

If the posts statistic is supplied, one can specify fields relating to posts through nested querying.\nNested parameters should be supplied as a comma separated list of values between curly braces following posts.

Example query:

GET /api/woolworths?statistics=posts{id, message}&access_token=<...>

Example response:

{\n    \"data\": {\n        \"posts\": {\n            \"data\": [\n                {\n                    \"message\": \"We’re currently taking a little break celebrating Easter, but we’ll be back on the 31st of March from 9am. For any urgent product safety issues please call 1800 638 434.\\n\\nYou can check opening times of your local store through Store Locator on our website.\\n\\nWe wish you all a very happy Easter. \\nhttps://www.woolworths.com.au/\",\n                    \"id\": \"147632815308858_1958529244219197\"\n                },\n                {\n                    \"message\": \"Would you say yes? 🤷🥑💍\",\n                    \"id\": \"147632815308858_10155253208306587\"\n                },\n                {\n                    \"message\": \"You have 30 seconds...GO! 😂\",\n                    \"id\": \"147632815308858_1943386495733472\"\n                }\n                ... more posts here\n            ],\n        }\n    }\n}\n

","urlObject":{"protocol":"https","path":["api","facebook"],"host":["unassigned-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"e682ce2f-c844-4fb2-838d-9ebbad25f39a","name":"Facebook Page Query","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://unassigned-api.herokuapp.com/api/facebook"},"code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"571904d8-3389-4235-a624-f4d29f21311e"},{"name":"/api/post/:id","event":[{"listen":"test","script":{"id":"e0b990f7-1969-4581-9b54-1e86a201c385","type":"text/javascript","exec":[""]}}],"id":"f2f10d4e-f611-40c0-b2e9-eb9305377b9e","request":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://unassigned-api.herokuapp.com/api/post/477181792361674_1490828694330307","description":"

This endpoint serves to pull information pertaining to a specific post on Facebook. The :id parameter is the unique Facebook post ID.

A user can specify the fields relating to the post by passing them as a comma separated list of values through the statistics parameter.

If no statistics are supplied, it will default to:

id - Facebook post ID
type - media type (photo/message etc.)
message
created_time
likes - number of likes the post has received
comments - number of comments made on the post

Example query: \nGET /api/post/147632815308858_1958529244219197?statistics=id,message&access_token=<...>

Example response:

{\n    \"data\": {\n        \"id\": \"147632815308858_1958529244219197\",\n        \"message\": \"We’re currently taking a little break celebrating Easter, but we’ll be back on the 31st of March from 9am. For any urgent product safety issues please call 1800 638 434.\\n\\nYou can check opening times of your local store through Store Locator on our website.\\n\\nWe wish you all a very happy Easter. \\nhttps://www.woolworths.com.au/\"\n    },\n    \"dev_team\": \"Team Unassigned\",\n    \"version\": \"1.0.0\",\n    \"start_time\": \"2018-03-30T00:52:33.852Z\",\n    \"end_time\": \"2018-03-30T01:08:08.403Z\",\n    \"time_elapsed\": 934551,\n    \"params\": {\n        \"statistics\": \"id,message\"\n    },\n    \"status\": 200,\n    \"status_text\": \"OK\"\n}\n

","urlObject":{"protocol":"https","path":["api","post","477181792361674_1490828694330307"],"host":["unassigned-api","herokuapp","com"],"query":[],"variable":[]}},"response":[{"id":"ab861664-4422-4e5f-8369-745253d084eb","name":"Facebook Post Query","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":""},"url":"https://unassigned-api.herokuapp.com/api/post/477181792361674_1490828694330307"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Access-Control-Allow-Headers","value":"Origin, X-Requested-With, Content-Type, Accept","name":"Access-Control-Allow-Headers","description":"Used in response to a preflight request to indicate which HTTP headers can be used when making the actual request."},{"key":"Access-Control-Allow-Origin","value":"*","name":"Access-Control-Allow-Origin","description":"Specifies a URI that may access the resource. For requests without credentials, the server may specify '*' as a wildcard, thereby allowing any origin to access the resource."},{"key":"Connection","value":"keep-alive","name":"Connection","description":"Options that are desired for the connection"},{"key":"Content-Length","value":"232","name":"Content-Length","description":"The length of the response body in octets (8-bit bytes)"},{"key":"Content-Type","value":"application/json; charset=utf-8","name":"Content-Type","description":"The mime type of this content"},{"key":"Date","value":"Fri, 27 Apr 2018 05:13:19 GMT","name":"Date","description":"The date and time that the message was sent"},{"key":"Etag","value":"W/\"e8-CXu8Q51jD2FN+YhNBi7lNKqKhkc\"","name":"Etag","description":"An identifier for a specific version of a resource, often a message digest"},{"key":"Server","value":"Cowboy","name":"Server","description":"A name for the server"},{"key":"Via","value":"1.1 vegur","name":"Via","description":"Informs the client of proxies through which the response was sent."},{"key":"X-Powered-By","value":"Express","name":"X-Powered-By","description":"Specifies the technology (ASP.NET, PHP, JBoss, e.g.) supporting the web application (version details are often in X-Runtime, X-Version, or X-AspNet-Version)"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f2f10d4e-f611-40c0-b2e9-eb9305377b9e"}],"event":[{"listen":"prerequest","script":{"id":"1ef1d5f1-2815-4844-b435-811ad27ddb27","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"ddd674f6-eb10-4123-86ce-bd7967274d76","type":"text/javascript","exec":[""]}}]}