Overview

Overview

This describes the resources that make up the official Loggator API v1. If you have any problems or requests please contact support.


Schema

All API access is over HTTPS, and accessed from the loggator.com domain . All data is sent and received as JSON.

All timestamps are returned in ISO 8601 format:

YYYY-MM-DDTHH:MM:SSZ


Client Errors

Server side errors:
HTTP/1.1 500 Internal Server Error
Content-Length: 33

{"error":"internal-server-error"}

Not Found Errors

Fetching non existent resources will result in the following 404 error:

HTTP/1.1 404 Not Found
Content-Length: 21

{"error":"not-found"}

HTTP Redirects

API v1 uses HTTP redirection where appropriate. Clients should assume that any request may result in a redirection. Receiving an HTTP redirection is not an error and clients should follow that redirect. Redirect responses will have a Location header field which contains the URI of the resource to which the client should repeat the requests.

Status Code Description
301 Permanent redirection. The URI you used to make the request has been superseded by the one specified in the Location header field. This and all future requests to this resource should be directed to the new URI.
302, 307 Temporary redirection. The request should be repeated verbatim to the URI specified in the Location header field but clients should continue to use the original URI for future requests.

Rate Limiting

Currently there is no rate limiting. This will change in the future.


Cross Origin Resource Sharing

The API supports Cross Origin Resource Sharing (CORS) for AJAX requests. you can read the CORS W3C working draft, or this intro from the HTML 5 Security Guide.

Here’s a sample request sent from a browser hitting http://example.com:

$ curl -i https://loggator.com/api/events/atP6hGVyxPIfHrUr.json -H "Origin: http://example.com"
HTTP/1.1 200 OK
`

JSON-P Callbacks

You can send a ?callback parameter to any GET call to have the results wrapped in a JSON function. This is typically used when browsers want to embed GitHub content in web pages by getting around cross domain issues. The response includes the same data output as the regular API

Last updated on 13th Jul 2017