Skip to main content

Auction a Data Instance

POST 

/v1/auction/:dataSourceId

Auction a Data Instance

Request

Path Parameters

    dataSourceId stringrequired

    The Data Source identifier.

Body

The request received from the client.

    dataSourceId stringrequired

    The Data Source identifier.

    dataInstance

    object

    required

    An instance of data with properties and values that conform to a Data Specification.

    dataSpecificationId stringrequired

    The Data Specification identifier that this Data Instance conforms to.

    properties

    object[]

    required

    The Data Instance properties.

  • Array [

  • name stringrequired

    The name of the property.

    value

    object

    required

    A property value. Only one value must be specified.

    oneOf

    addressValue

    object

    required

    An address.

    line1 string

    (Optional) The first line of the address.

    line2 string

    (Optional) The second line of the address.

    townCity string

    (Optional) The town / city of the address.

    region string

    (Optional) The region of the address.

    postcode string

    (Optional) The postal code of the address.

    countryCode string

    (Optional) The two letter ISO 3166 country code of the address.

    latLon

    object

    An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.

    latitude double

    The latitude in degrees. It must be in the range [-90.0, +90.0].

    longitude double

    The longitude in degrees. It must be in the range [-180.0, +180.0].

  • ]

Responses

OK

Schema

    timestamp date-timerequired

    When the auction took place.

    dataInstanceId stringrequired

    The Data Instance identifier.

    results

    object[]

    required

    The auction results.

  • Array [

  • campaignId stringrequired

    The Campaign identifier.

    metadata stringrequired

    Any metadata registered for this Campaign.

    amount

    object

    required

    Represents an amount of money with its currency type.

    currencyCode stringrequired
    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.

  • ]

  • sold booleanrequired

    Did the Data Instance sell?

Loading...