Response Object Structure¶

All responses returned by ZeroGuard Recon API have a unified structure. This page describes how non-error responses are structured. For a structure of error responses refer to Errors section.

Structure¶

Non-Error Response¶

General structure of a non-error API response.

Object Properties:

_meta (object) – Contextual meta information about the response. May be absent.
query (Query Object) – Contextual information about the query that was performed. Essentially, this object just mirrors request parameters that were specified (after a disambiguation and resolution process). Object structure is defined individually for each API endpoint. Always present.
data (Data Object) – Results of a performed query (request). Always present.

Query Object¶

Structure of a query object.

Object Properties:
	action (string) –

Todo

Fill out response body query object structure

Data Object¶

General structure of a non-error API response data.

Object Properties:
	records (list) – List of records returned by the back-end. Object structure is defined individually for each API response. Always present. references (map) – Mapping of _ref (reference number) to a referenced object. See Object References for details. Included only if records reference any related objects. May be absent.

Todo

Describe a structure of _meta object

Examples¶

{
    "_meta": {},
    "query": {
        "domain": "example.com"
    },
    "data": {
        "records": [
        ],
        "references": {
        }
    }
}

A recommended way of getting data out of API response:

Check HTTP status code of the response.

Todo

More decent examples (or at least one example that is full)