v1

latestOpenAPI 3.0.3Apache 2.02026-07-133681213.9 KB

Logs

Get all consumer request logs

This endpoint includes all consumer request logs.

get/vault/logs

Query parameters

connector_idstring nullable

Filter by connector ID. Known limitation: this field is not currently applied at the log query resolver — connector filtering is performed via the service identifier internally (see GH-10099).

pathstring nullable

Filter by request path. Match behavior is controlled by path_match_mode (defaults to CONTAINS).

path_match_mode'CONTAINS' | 'STARTS_WITH' | 'ENDS_WITH' | 'EXACT' nullable

How the path filter is matched. CONTAINS matches the path anywhere; STARTS_WITH / ENDS_WITH anchor the match; EXACT requires the whole path to match. Only applied when path is set.

http_methodstring nullable

Filter by a single HTTP method.

http_methodsstring[] nullable

Filter by multiple HTTP methods.

start_datestring date-time nullable

Filter logs at or after this ISO 8601 date-time (inclusive).

end_datestring date-time nullable

Filter logs at or before this ISO 8601 date-time (inclusive). Must be on or after start_date.

status_codenumber nullable

Filter by a single HTTP status code. For backward compatibility - use status_codes for multiple values.

status_codesnumber[] nullable

Filter by multiple HTTP status codes. Values must be between 100-599. Maximum 50 status codes allowed.

exclude_unified_apisstring nullable

Filter results

{
  "connector_id": "crm+salesforce",
  "path": "/crm/contacts",
  "http_method": "GET",
  "http_methods": [
    "GET",
    "POST"
  ],
  "start_date": "2024-01-01T00:00:00.000Z",
  "end_date": "2024-01-31T23:59:59.999Z",
  "status_code": 201,
  "status_codes": [
    200,
    201,
    204
  ],
  "exclude_unified_apis": "vault,proxy"
}

cursorstring nullable

Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.

limitinteger

Number of results to return. Minimum 1, Maximum 200, Default 20

Headers

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

Response

Logs

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "data": [
    {
      "api_style": "REST",
      "base_url": "unify.apideck.com",
      "consumer_id": "test-consumer",
      "duration": 2220.379304,
      "error_message": "Refresh token is invalid",
      "execution": 2248,
      "http_method": "GET",
      "id": "0b5f7480-5550-4f5c-a5fc-3c01ac43dd0f",
      "latency": 27.620695999999953,
      "operation": {
        "id": "connectionsAll",
        "name": "Get All Connections"
      },
      "parent_id": "0b5f7480-5550-4f5c-a5fc-3c01ac43dd0f",
      "path": "/vault/connections",
      "service": {
        "id": "apideck-vault",
        "name": "Apideck Vault"
      },
      "source_ip": "94.227.131.238",
      "status_code": 200,
      "success": true,
      "timestamp": "2021-07-12T14:26:17.420Z",
      "unified_api": "vault"
    }
  ],
  "meta": {
    "items_on_page": 50,
    "cursors": {
      "previous": "em9oby1jcm06OnBhZ2U6OjE=",
      "current": "em9oby1jcm06OnBhZ2U6OjI=",
      "next": "em9oby1jcm06OnBhZ2U6OjM="
    },
    "total_count": 1,
    "warnings": [
      {
        "type": "downstream_request_failed",
        "status_code": 429,
        "operation": "getManager"
      }
    ]
  },
  "links": {
    "previous": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjE%3D",
    "current": "https://unify.apideck.com/crm/companies",
    "next": "https://unify.apideck.com/crm/companies?cursor=em9oby1jcm06OnBhZ2U6OjM"
  }
}