Get a micro-batch match run

GET

/v1/match/runs/{runId}

const url = 'https://dev-api.infiniteaudience.ai/v1/match/runs/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://dev-api.infiniteaudience.ai/v1/match/runs/example \
  --header 'Authorization: Bearer <token>'

Get a single micro-batch match run by ID. Requires ‘discovery’ scope.

Authorizations

bearerAuth

Parameters

Path Parameters

runId

required

string

Responses

200

Micro-batch match run

application/json

A single micro-batch match run record. amount_charged is a conservative pending-usage estimate, not a finalized invoice amount.

object

run_id

required

string

type

required

string

Allowed values: microbatch

status

required

string

Allowed values: completed failed

input_record_count

required

integer

match_count

required

integer

match_rate

required

number format: float

amount_charged

required

Conservative USD estimate accepted for billing; not a finalized invoice total.

number format: float

field_list

required

Array<string>

created_at

required

string | null format: date-time

expires_at

required

string | null

Example

{
  "type": "microbatch",
  "status": "completed"
}

401

Missing or invalid Bearer token. Obtain one via POST /v1/auth/token. When a token was supplied but rejected, code distinguishes TOKEN_EXPIRED (the token’s lifetime has passed — request a new one via POST /v1/auth/token and retry) from TOKEN_INVALID (malformed or revoked — re-authenticate).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

{
  "error": "Unauthorized: Missing or invalid Authorization header"
}

{
  "error": "Unauthorized",
  "code": "TOKEN_EXPIRED",
  "message": "Your session has expired. Please sign in again."
}

403

Token is valid but lacks the required scope for this endpoint. Check the endpoint description for the required scope (discovery, purchase, or account).

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

missing_scope

{
  "error": "SCOPE_REQUIRED",
  "message": "This endpoint requires the purchase scope."
}

404

Resource not found or not accessible to the calling org.

application/json

object

error

required

Stable machine-readable error code (e.g. INVALID_STATUS_TRANSITION, BILLING_INSUFFICIENT_BALANCE). Always present.

string

message

Human-readable explanation of the error.

string

code

Alternate machine-readable code — present on some endpoints as an alias for error for backward compatibility.

string

request_id

Opaque support/debug identifier when available.

string

key

additional properties

any

Examples

not_found

{
  "error": "Audience not found"
}