GoSquared API Documentation
The GoSquared API enables developers to build their own awesome projects and applications on top of the GoSquared real-time analytics platform.
By leveraging GoSquared's powerful API, developers can use the real-time analytics data we collect to power their applications, regardless of programming language or platform.
How to make requests
Requests are made using a simple HTTP(S) interface:
http[s]://api.gosquared.com/[function_name][.format][?param1=[value1]][¶m2=[value2]][...]
Parameters are function-specific, and some are required. Usually, you'll need to specify the following parameters:
api_key |
The API key of your account. You can find this in the Settings |
site_token |
The token of the site you are retrieving data for. You can also find this in the Settings. It will be something like GSN-1234567-X |
format |
The formatting of the response data. Defaults to json for data-type functions and png for image-type functions. |
The same requests will work over https.
API Functions
All of the available functions and output formats for this version of the API are listed in the sidebar to the right. Browse through the functions by clicking through this list. Some functions require authentication, which means you must possess the API key for the account that you are trying to retrieve data for.
API Request Limits
The API employs a complexity-based request limiting scheme. The limit stands at an average of 4 units per second, and each API function uses a certain number of units each time it is called based on its complexity. The number of units used by each function is documented on the function's page.
API Versions
The latest version of the API is 1.1
GoSquared PHP SDK
We've built a quick and simple SDK for using the GoSquared API in PHP applications - get it on GitHub →