Request Log
request_log objectA log of a single API request, capturing its route, outcome, latency, and actor.
idstringRequest log ID.
objectstringenumValues:request_logResource type identifier.
methodstringHTTP method.
hoststringRequest host.
Usually api.augno.com.
pathstringThe exact path the request was made to, including path parameter values.
normalized_routestringThe 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_paramsobjectnullableQuery parameters.
Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.
status_codeintegerHTTP response status code (e.g. 200, 404).
latency_usintegerRequest latency in microseconds.
api_versionstringnullableAPI version used.
client_ipstringnullableClient IP address.
user_agentstringnullableUser agent.
referrerstringnullableReferrer header.
error_codestringnullableMachine-readable API error code.
Populated only for failed requests.
error_messagestringnullableHuman-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.
accountaccountnullableAccount 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.
idstringAccount ID.
objectstringenumValues:accountResource type identifier.
namestringThe account's display name.
Default billing address.
null in this endpoint.Default shipping address.
null in this endpoint.brandingaccount_brandingnullableCustomer-facing branding for the account, such as the logo, support contacts, and social links.
null in this endpoint.portalaccount_portalnullableThe account's customer portal settings, including the portal URL slug.
null in this endpoint.created_atstring (date-time)Creation timestamp.
updated_atstring (date-time)Last updated timestamp.
actoractornullableActor who made the request.
idstringUnique identifier of the actor.
objectstringenumValues:actorResource type identifier.
typestringenumValues:userapi_keyagentActor 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.
namestringnullableThe actor's display name.
handlestringnullableHuman-readable handle identifying the actor.
- For
useractors: the user's email address. - For
api_keyactors: the redacted key value.
Other actor types carry no handle.
avatar_urlstringnullableURL of the actor's profile photo, if one is set.
Only populated for user actors.
Assigned role.
idstringRole ID.
objectstringenumValues:roleResource type identifier.
namestringDisplay name, unique within the account.
typestringenumValues:adminuserscannerThe 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.
ownerownernullableProvenance 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.
null in this endpoint.permissionsarray of stringnullablePermissions 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_keystringnullableUser-provided idempotency key.
request_bodyobjectnullableRequest body.
Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.
response_bodyobjectnullableResponse body.
Encoded as a JSON value (object, array, string, number, boolean, or null), not a JSON-encoded string.