Table of contents

API Reference

The API Reference contains the details of the various APIs you need to control the GrayMeta Platform, and access the data.

About the API

The GrayMeta Platform API is a JSON/HTTP RESTful API (learn more about REST on Wikipedia), and as such uses HTTP methods and paths for requests, and status codes and bodies in responses. All API endpoints adhere to the same policy on errors.

Primary APIs

The primary APIs for interacting with the GrayMeta Platform are:

  • Audit API
  • Containers API
  • Harvest API
  • Items API
  • Segments API
  • Locations API (and Location Kinds API)
  • Search API
  • Comments API
  • Reports API
  • Saved Searches API
  • Compilations API
  • Keywords API
  • Roles API

Other APIs

You can use the navigation to the left to explore other APIs, or follow the threads through the Primary APIs above.

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.