Frontend Logging REST API

Log REST API documentation and interactive testing.

For the OpenAPI Specification document use this link: https://apis.objectsgrid.com/log/contract

Create object

post

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Body

application/json

schemaVersionstringRequiredExample: 1.0

environmentstringRequiredExample: prod

platformstringRequiredExample: web

baseUrlstring · uriOptional

sentAtstring · date-timeRequired

Responses

201

Successfully created the object

application/json

400

Bad request

application/json

401

Unauthorized

application/json

409

Conflict, object already exists

application/json

429

Too Many Requests - rate limited

application/json

500

Internal Server Error

application/json

post

/log

HTTPcURLJavaScriptPython

POST /log HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Content-Type: application/json
Accept: */*
Content-Length: 2047

{
  "schemaVersion": "1.0",
  "app": {
    "name": "text",
    "version": "text",
    "build": "text",
    "releaseId": "text"
  },
  "environment": "prod",
  "platform": "web",
  "baseUrl": "https://example.com",
  "sentAt": "2026-03-14T09:21:26.903Z",
  "session": {
    "sessionId": "text",
    "installId": "text",
    "correlationId": "text",
    "requestId": "text",
    "traceId": "text",
    "spanId": "text"
  },
  "auth": {
    "method": "oidc",
    "state": "anonymous",
    "userId": "text"
  },
  "client": {
    "locale": "text",
    "timezone": "text",
    "userAgent": "text",
    "sdk": {
      "name": "text",
      "version": "text"
    }
  },
  "device": {
    "type": "phone",
    "manufacturer": "text",
    "model": "text",
    "osName": "text",
    "osVersion": "text"
  },
  "network": {
    "type": "wifi",
    "effectiveType": "slow-2g",
    "carrier": "text",
    "roaming": true,
    "metered": true
  },
  "geo": {
    "latitude": 1,
    "longitude": 1,
    "accuracyMeters": 1,
    "source": "gps",
    "capturedAt": "2026-03-14T09:21:26.903Z"
  },
  "web": {
    "browserName": "text",
    "browserVersion": "text",
    "pageUrl": "https://example.com",
    "referrer": "https://example.com",
    "viewport": {
      "width": 1,
      "height": 1
    },
    "userAgent": "text"
  },
  "mobile": {
    "appState": "foreground",
    "screenName": "text",
    "permissions": {
      "ANY_ADDITIONAL_PROPERTY": "granted"
    }
  },
  "entries": [
    {
      "timestamp": "2026-03-14T09:21:26.903Z",
      "severity": "debug",
      "eventType": "log",
      "title": "text",
      "message": "text",
      "error": {
        "type": "text",
        "code": "text",
        "message": "text",
        "unhandled": true,
        "fatal": true,
        "stack": "text",
        "cause": {
          "type": "text",
          "code": "text",
          "message": "text",
          "unhandled": true,
          "fatal": true,
          "stack": "text",
          "cause": {
            "type": "text",
            "code": "text",
            "message": "text",
            "unhandled": true,
            "fatal": true,
            "stack": "text",
            "cause": "[Circular Reference]"
          }
        }
      },
      "stackTrace": "text",
      "ui": {
        "screenName": "text",
        "component": "text",
        "route": "text",
        "display": {
          "width": 1,
          "height": 1,
          "pixelRatio": 1,
          "orientation": "text"
        }
      },
      "http": {
        "method": "text",
        "status": 1,
        "urlTemplate": "text",
        "durationMs": 1,
        "retryCount": 1
      },
      "context": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "performance": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "infoObject": "text",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

{
  "schemaVersion": "1.0",
  "app": {
    "name": "text",
    "version": "text",
    "build": "text",
    "releaseId": "text"
  },
  "environment": "prod",
  "platform": "web",
  "baseUrl": "https://example.com",
  "sentAt": "2026-03-14T09:21:26.903Z",
  "session": {
    "sessionId": "text",
    "installId": "text",
    "correlationId": "text",
    "requestId": "text",
    "traceId": "text",
    "spanId": "text"
  },
  "auth": {
    "method": "oidc",
    "state": "anonymous",
    "userId": "text"
  },
  "client": {
    "locale": "text",
    "timezone": "text",
    "userAgent": "text",
    "sdk": {
      "name": "text",
      "version": "text"
    }
  },
  "device": {
    "type": "phone",
    "manufacturer": "text",
    "model": "text",
    "osName": "text",
    "osVersion": "text"
  },
  "network": {
    "type": "wifi",
    "effectiveType": "slow-2g",
    "carrier": "text",
    "roaming": true,
    "metered": true
  },
  "geo": {
    "latitude": 1,
    "longitude": 1,
    "accuracyMeters": 1,
    "source": "gps",
    "capturedAt": "2026-03-14T09:21:26.903Z"
  },
  "web": {
    "browserName": "text",
    "browserVersion": "text",
    "pageUrl": "https://example.com",
    "referrer": "https://example.com",
    "viewport": {
      "width": 1,
      "height": 1
    },
    "userAgent": "text"
  },
  "mobile": {
    "appState": "foreground",
    "screenName": "text",
    "permissions": {
      "ANY_ADDITIONAL_PROPERTY": "granted"
    }
  },
  "entries": [
    {
      "timestamp": "2026-03-14T09:21:26.903Z",
      "severity": "debug",
      "eventType": "log",
      "title": "text",
      "message": "text",
      "error": {
        "type": "text",
        "code": "text",
        "message": "text",
        "unhandled": true,
        "fatal": true,
        "stack": "text",
        "cause": {
          "type": "text",
          "code": "text",
          "message": "text",
          "unhandled": true,
          "fatal": true,
          "stack": "text",
          "cause": {
            "type": "text",
            "code": "text",
            "message": "text",
            "unhandled": true,
            "fatal": true,
            "stack": "text",
            "cause": "[Circular Reference]"
          }
        }
      },
      "stackTrace": "text",
      "ui": {
        "screenName": "text",
        "component": "text",
        "route": "text",
        "display": {
          "width": 1,
          "height": 1,
          "pixelRatio": 1,
          "orientation": "text"
        }
      },
      "http": {
        "method": "text",
        "status": 1,
        "urlTemplate": "text",
        "durationMs": 1,
        "retryCount": 1
      },
      "context": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "performance": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "infoObject": "text",
      "extensions": {
        "ANY_ADDITIONAL_PROPERTY": {
          "ANY_ADDITIONAL_PROPERTY": "anything"
        }
      }
    }
  ],
  "extensions": {
    "ANY_ADDITIONAL_PROPERTY": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    }
  }
}

List objects

get

This operation supports Elastic Search Query DSL query format

Authorizations

accessTokenAuth

AuthorizationstringRequired

JWT Access Token obtained from Create User Account Access Token operation.

Query parameters

langstringOptional

BCP 47 language code

Example: fr, de, de-AT, cy-GB

querystringOptional

Elastic Search Query DSL.

Example: { "query": { "match_all": {} } }

fromintegerOptional

Defines the starting record number for retrieval.

sizeintegerOptional

Defines the number of records to retrieve.

Header parameters

X-ObjectsGrid-AccessPointstring · enumRequired

EU or US depending on where your Organization Account is located

Possible values:

X-ObjectsGrid-RestApiVersionstringOptional

This header allows targeting an API version. If you want to target the latest API version set its value to 'latest' If you want to target the latest stable API version set its value to 'stable'

X-ObjectsGrid-SessionIDstringOptional

This header allows you to provide a Session ID to be traced through the request stack and returned in the response.

Responses

200

Successfully listed the objects

application/json

400

Bad request

application/json

401

Unauthorized

application/json

429

Too Many Requests - rate limited

application/json

500

Internal Server Error

application/json

get

/log

HTTPcURLJavaScriptPython

GET /log HTTP/1.1
Host: apis.objectsgrid.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-ObjectsGrid-AccessPoint: EU
Accept: */*

[
  {
    "id": "text",
    "schemaVersion": "1.0",
    "app": {
      "name": "text",
      "version": "text",
      "build": "text",
      "releaseId": "text"
    },
    "environment": "prod",
    "platform": "web",
    "baseUrl": "https://example.com",
    "sentAt": "2026-03-14T09:21:26.903Z",
    "session": {
      "sessionId": "text",
      "installId": "text",
      "correlationId": "text",
      "requestId": "text",
      "traceId": "text",
      "spanId": "text"
    },
    "auth": {
      "method": "oidc",
      "state": "anonymous",
      "userId": "text"
    },
    "client": {
      "locale": "text",
      "timezone": "text",
      "userAgent": "text",
      "sdk": {
        "name": "text",
        "version": "text"
      }
    },
    "device": {
      "type": "phone",
      "manufacturer": "text",
      "model": "text",
      "osName": "text",
      "osVersion": "text"
    },
    "network": {
      "type": "wifi",
      "effectiveType": "slow-2g",
      "carrier": "text",
      "roaming": true,
      "metered": true
    },
    "geo": {
      "latitude": 1,
      "longitude": 1,
      "accuracyMeters": 1,
      "source": "gps",
      "capturedAt": "2026-03-14T09:21:26.903Z"
    },
    "web": {
      "browserName": "text",
      "browserVersion": "text",
      "pageUrl": "https://example.com",
      "referrer": "https://example.com",
      "viewport": {
        "width": 1,
        "height": 1
      },
      "userAgent": "text"
    },
    "mobile": {
      "appState": "foreground",
      "screenName": "text",
      "permissions": {
        "ANY_ADDITIONAL_PROPERTY": "granted"
      }
    },
    "extensions": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "timestamp": "2026-03-14T09:21:26.903Z",
    "severity": "debug",
    "message": "text",
    "eventType": "log",
    "title": "text",
    "error": {
      "type": "text",
      "code": "text",
      "message": "text",
      "unhandled": true,
      "fatal": true,
      "stack": "text",
      "cause": {
        "type": "text",
        "code": "text",
        "message": "text",
        "unhandled": true,
        "fatal": true,
        "stack": "text",
        "cause": {
          "type": "text",
          "code": "text",
          "message": "text",
          "unhandled": true,
          "fatal": true,
          "stack": "text",
          "cause": {
            "type": "text",
            "code": "text",
            "message": "text",
            "unhandled": true,
            "fatal": true,
            "stack": "text",
            "cause": "[Circular Reference]"
          }
        }
      }
    },
    "stackTrace": "text",
    "ui": {
      "screenName": "text",
      "component": "text",
      "route": "text",
      "display": {
        "width": 1,
        "height": 1,
        "pixelRatio": 1,
        "orientation": "text"
      }
    },
    "http": {
      "method": "text",
      "status": 1,
      "urlTemplate": "text",
      "durationMs": 1,
      "retryCount": 1
    },
    "context": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "performance": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "entryExtensions": {
      "ANY_ADDITIONAL_PROPERTY": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    },
    "infoObject": "text",
    "tags": [
      {
        "name": "text",
        "val": "text"
      }
    ],
    "meta": {
      "objectVersion": 1,
      "objectType": "text",
      "namespace": "text",
      "createdAt": "2026-03-14T09:21:26.903Z",
      "createdBy": "text",
      "lastUpdatedAt": "2026-03-14T09:21:26.903Z",
      "lastUpdatedBy": "text",
      "lastUpdateCorrelationID": "text"
    }
  }
]