List Data Instances

GET 
/v1/campaigns/:campaignId/data-instances

List Data Instances

Request

Path Parameters

campaignId stringrequired

Filter to a Campaign identifier.

Query Parameters

winner boolean

Filter by either won or lost.

formatted boolean

Return the Data Instance with formatted values.

dateRange.from date-time

From date, inclusive.

dateRange.to date-time

To date, inclusive.

Responses

200

OK

application/json

Schema

Schema

instances

object[]

required

Array [

id stringrequired

The identifier of the Data Instance.

auctionDate date-timerequired

The date time on which the Data Instance was auctioned.

roles DataInstanceRole (string)[]required

The roles played in the Data Instance.

Possible values: [SELLER, BUYER]

winner boolean

(Optional) Whether the caller of the Data Instance is the winner.

campaignId string

(Optional) The identifier of the Campaign that won the Data Instance.

bid

object

Represents an amount of money with its currency type.

currencyCode stringrequired

The three-letter currency code defined in ISO 4217.

units int64required

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

nanos int32required

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

paid

object

Represents an amount of money with its currency type.

currencyCode stringrequired

The three-letter currency code defined in ISO 4217.

units int64required

The whole units of the amount. For example if currencyCode is "USD", then 1 unit is one US dollar.

nanos int32required

Number of nano (10^-9) units of the amount. The value must be between -999,999,999 and +999,999,999 inclusive. If units is positive, nanos must be positive or zero. If units is zero, nanos can be positive, zero, or negative. If units is negative, nanos must be negative or zero. For example $-1.75 is represented as units=-1 and nanos=-750,000,000.

properties

object[]

required

The properties of the Data Instance.

Array [

label stringrequired

The label of the detail.

value required

The value of the detail.

]

]

Example (from schema)

{
  "instances": [
    {
      "id": "string",
      "auctionDate": "2024-07-29T15:51:28.071Z",
      "roles": [
        "SELLER"
      ],
      "winner": true,
      "campaignId": "string",
      "bid": {
        "currencyCode": "string",
        "units": "string",
        "nanos": 0
      },
      "paid": {
        "currencyCode": "string",
        "units": "string",
        "nanos": 0
      },
      "properties": [
        {
          "label": "string"
        }
      ]
    }
  ]
}

default

Error

application/json

Schema

Schema

code int32

An error status code describing the response.

Enum Value	Description
0	OK
1	Cancelled
2	Unknown
3	InvalidArgument
4	DeadlineExceeded
5	NotFound
6	AlreadyExists
7	PermissionDenied
8	ResourceExhausted
9	FailedPrecondition
10	Aborted
11	OutOfRange
12	Unimplemented
13	Internal
14	Unavailable
15	DataLoss
16	Unauthenticated

Possible values: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16]

message string

A developer-facing error message

details

object[]

A list of messages containing details about the errors

Array [

@type stringrequired

]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...