List Request Logs

Beta
GET/v1/core/request-logs

This endpoint is idempotent. Learn more

Returns a paginated list of request logs for the current account.

Permissions requiredValues:request_logs:read
The role behind your API key or agent must grant every one of these permissions.
cursoroptional string

Opaque cursor token identifying where the page of results starts.

Use the cursor value embedded in a previous response's next_page_url or previous_page_url to fetch the adjacent page. Omit to start from the first page.

limitoptional integer

Maximum number of results to return in a single page.

qoptional string

Free-text search term used to filter results.

Which fields are matched against the term varies by endpoint.

start_dateoptional string (date-time)

Restricts results to request logs on or after this timestamp.

end_dateoptional string (date-time)

Restricts results to request logs on or before this timestamp.

methods[]optional arrayenumValues:GETPOSTPUT

Filter by the HTTP method.

status_codes[]optional array

Filter by the HTTP status code.

status_code_classes[]optional array

Filter by the HTTP status class, expressed as the leading digit: 15 for 1xx–5xx.

Combined with status_codes using OR — e.g. status_codes=401 and status_code_classes=5 matches 401 responses and any 5xx response.

error_codes[]optional arrayenumValues:expired_tokenapi_key_expiredapi_key_revoked

Filter by API error code.

actor_account_ids[]optional array

Filter by the acting account: the account the actor belongs to (the log's account.id).

Results are always scoped to logs where your account is either the acting account or the target account; this narrows that set to specific acting accounts. For example, pass a customer's account ID to see only requests that customer's actors made against your account.

target_account_ids[]optional array

Filter by the target account: the account the request acted upon (the log's target account).

Results are always scoped to logs where your account is either the acting account or the target account; this narrows that set to specific target accounts. For example, pass a supplier's account ID to see only requests your account made against that supplier.

actor_ids[]optional array

Filter by the actor identifier.

Matches the log's actor.id: a user ID for user actors or an API key ID for api_key actors.

actor_types[]optional arrayenumValues:userapi_keyagent

Filter by the actor type.

normalized_routes[]optional array

Filter by the normalized route template.

For example /v1/sales/customers/{id} matches every request to that route regardless of the specific customer ID. Parameter names inside {} are ignored when matching, so {customer_id} and {id} are equivalent.

hosts[]optional array

Filter by the request host.

Typically api.augno.com.

min_latency_usoptional integer

Restricts results to requests that took at least this many microseconds.

idempotency_keyoptional string

Filter by the user-provided idempotency key.

include[]optional arrayenumValues:accountactoractor.role

Sub-objects to expand in the response. When omitted, sub-objects are returned as null.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of request_log

Resources in this page.

idstring

Request log ID.

objectstringenumValues:request_log

Resource type identifier.

methodstring

HTTP method.

hoststring

Request host.

Usually api.augno.com.

pathstring

The exact path the request was made to, including path parameter values.

normalized_routestring

The route template the request matched, with path parameters left as placeholders.

For example /v1/sales/customers/{id} is the normalized route for the request path /v1/sales/customers/ac_.... Falls back to the raw path when the request did not match a registered route.

query_paramsobjectnullable

Query parameters.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

status_codeinteger

HTTP response status code (e.g. 200, 404).

latency_usinteger

Request latency in microseconds.

api_versionstringnullable

API version used.

client_ipstringnullable

Client IP address.

user_agentstringnullable

User agent.

referrerstringnullable

Referrer header.

error_codestringnullable

Machine-readable API error code.

Populated only for failed requests.

error_messagestringnullable

Human-readable error message.

Populated only for failed requests.

occurred_atstring (date-time)

When the request occurred.

created_atstring (date-time)

When the log entry was created.

accountaccountExpandablenullable

Account targeted by the request: the account the request acted upon.

Results are scoped to logs where your account is either the acting account or the target account. Use the target_account_ids query parameter to filter by which account was acted upon, and actor_account_ids to filter by who acted.

idstring

Account ID.

objectstringenumValues:account

Resource type identifier.

namestring

The account's display name.

default_billing_addressaddressnullable

Default billing address.

Always returned as null in this endpoint.
default_shipping_addressaddressnullable

Default shipping address.

Always returned as null in this endpoint.
brandingaccount_brandingnullable

Customer-facing branding for the account, such as the logo, support contacts, and social links.

Always returned as null in this endpoint.
portalaccount_portalnullable

The account's customer portal settings, including the portal URL slug.

Always returned as null in this endpoint.
created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

actoractorExpandablenullable

Actor who made the request.

idstring

Unique identifier of the actor.

objectstringenumValues:actor

Resource type identifier.

typestringenumValues:userapi_keyagent

Actor type.

  • user: a human user account.
  • api_key: a programmatic caller authenticating with an API key.
  • agent: an automated agent acting on the account's behalf.
  • group: a shared group identity, such as a "Customer Service" persona, rather than a single individual.
namestringnullable

The actor's display name.

handlestringnullable

Human-readable handle identifying the actor.

  • For user actors: the user's email address.
  • For api_key actors: the redacted key value.

Other actor types carry no handle.

avatar_urlstringnullable

URL of the actor's profile photo, if one is set.

Only populated for user actors.

roleroleExpandablenullable

Assigned role.

idstring

Role ID.

objectstringenumValues:role

Resource type identifier.

namestring

Display name, unique within the account.

typestringenumValues:adminuserscanner

The kind of role.

The role's type is sometimes used to gate special behaviors and to restrict some actions to only certain types of roles. For example, only roles with the type admin can create and manage API keys.

  • admin: full administrative access, including managing API keys.
  • user: a custom role tailored to a specific need (its permissions are defined explicitly). Roles created through the API always have this type.
  • scanner: a role for scanning-station operators.
  • sales_rep: a role for sales representatives.
  • agent: a role assigned to an automated agent rather than a person.
ownerownernullable

Provenance of this role.

System-owned roles are global defaults shared across all accounts and cannot be modified or deleted; account-owned roles are custom roles created by that account.

Always returned as null in this endpoint.
permissionsarray of stringnullable

Permissions granted by this role, in {domain}:{action} format, such as customers:read.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

idempotency_keystringnullable

User-provided idempotency key.

request_bodyobjectnullable

Request body.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

response_bodyobjectnullable

Response body.

Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.

Responses

200

Successful response for List Request Logs