How to read the GrayMeta Platform API Documentation

The GrayMeta Platform API Documentation follows some simple formatting practices to make it easy to read.

Code

Code or field names are presented like this.

Blocks of code, or example JSON, are presented like this:

{
	"key": "value"
}

If there are placeholders inside the JSON, a bulleted list following the code block will explain each one:

{
	"location_id": "{id}"
}

id - (string) The ID of the location

API requests and responses

RESTful API requests are described using the HTTP method and path:

GET /something

If the request has a body, it will immediately follow the request line:

POST /something
{
	"body": true
}

Responses are usually just a code block of JSON:

{
	"key1": "value",
	"key2": "value2"
}

Placeholders inside URLs will be written using curly braces, followed by a breakdown of each parameter:

GET /something/{id}/{detail}

{id} - (string) A unique ID
{detail} - (string) Some other detail

What next?

Jump into the introductory documentation to learn about how the GrayMeta Platform works.

This documentation is generated from the latest version of GrayMeta Platform. For documentation relevant to your own deployed version, please use the documentation inside the application.

Table of contents

How to read the GrayMeta Platform API Documentation

Code

API requests and responses

What next?