Skip to main content
GET
Get a request

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Path Parameters

requestId
string
required

The request's id, as its X-Request-Id header and the requests list give it.

Maximum string length: 100
Pattern: ^[A-Za-z0-9_-]+$

Response

The request, with its bodies.

id
string

The request's id, as its X-Request-Id header gave it.

createdAt
string<date-time>
method
string
endpoint
string

The route called, such as /v1/people/search.

product
enum<string>
Available options:
search,
enrichment,
lists,
campaigns,
connections,
account
statusCode
integer
latencyMs
integer
units
integer

What the call was billed for: 0 on a miss. Absent for a call that bills nothing.

costUsd
string

What the call cost, in US dollars.

apiKey
object

The key that made the call. Its name and masked form are absent when the key no longer exists.

isReplay
boolean

Whether the answer was an earlier request's, replayed.

isMiss
boolean

The call succeeded but found nothing, so it cost nothing.

isHeld
boolean

Money is still set aside for it: the call is running or its charge is not final yet.

ip
string

The address the call came from.

idempotencyKey
string

The idempotency key the call carried, if any.

requestBody
string

The request body as JSON text, at most 16 KB, with keys and passwords removed.

responseBody
string

The answer's body as JSON text, at most 16 KB.

balanceAfterUsd
string

The balance after the call's charge, for a charged call.