View Campaign pricing

GET /campaigns/{id}/pricing
Copied
Arrow
                https://api.ocamba.com/v2/adex/campaigns/{id}/pricing

Retrieves the details of a Campaign pricing that has previously been created if a valid identifier was provided

path Parameters
Arrow
Name
Description
campaign_idintegerrequired
Unique campaign identifier defined as a path parameter.


Example: 1234142
query Parameters
Arrow
Name
Description
fieldsstring
The client can request more efficient filtered representation of the resource showing only specific field(s), using the “fields” query parameter. Note that the “fields” parameter has precedence over the “view” parameter.

Example GET /VERSION/adex/RESOURCE_NAME?fields=id,name

See "Tips" for the list of filterable parameters.


Example: fields=field1,field2,field3
viewstring
Adex API returns full representation of the resource using the “view=full” query parameter. If not specified, the default view will be used.

Note that the “fields” parameter has precedence over the “view” parameter.


Example: view=full/default

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ pricing ]
An array of all created items.
Pricing
Name
Description
attributednumber (integer)
Cannot be set via POST or PATCH - it is automatically set when an attribute endpoint is executed.


Example: 1

Possible values: 0 | 1
campaign_idstring
A unique company identifier generated by the Ocamba platform.


Example: 1237123
company_idstring
A unique identifier generated by the Ocamba platform.


Example: 1234123
conversion_idstring
Only applicable on CPA campaigns.


Example: 12342
conversion_repeatnumber (integer)
Repeated conversion feature, if enabled, repeated conversion will be accepted and taken into account.


Example: 1

Possible values: 0 | 1
create_timestring
Timezone: GMT.


Example: 2021-10-29 12:47:00
currency_codestring
Three-letter currency code.


Example: USD
modifier_typestring
Describes strategy how you want to apply modifier value to the base price.


Example: exact-value

Possible values: exact-value | percent
modifiers[ modifier ]
Array of Modifiers object.
Modifier
Name
Description
categories[ string ]
Array of IAB categories.


Example: IAB1-1,IAB2-1
countries[ string ]
Array of countries targets.


Example: RS, JP
idstring
A unique identifier generated by the Ocamba platform.


Example: 95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b
subid[ string ]
Array of subid targets.


Example: lux_w10_0203-BERNIE-905
valuefloat
Modifier value.


Example: 1.2
pricefloat
Base price. Minimum value: 0.001. Maximum value: 1000.


Example: 5
update_timestring
Timezone: GMT.


Example: 2021-10-30 14:27:26
totalinteger
A total number of items.


Example: 1
tip
1 If you don't know the campaign id, list the campaigns pricing to find it.
2 Searchable field is modifiers.
3 Sortable fields are create_time and update_time.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
{
  "total": 1,
  "items": [
    {
      "company_id": "6197120",
      "campaign_id": "1010787",
      "conversion_id": "12449",
      "currency_code": "USD",
      "price": 0.2,
      "conversion_repeat": "1",
      "modifier_type": "exact-value",
      "modifiers": [
        {
          "id": "dd1b39c5-4dbe-4fb7-8d25-19523c1d295c",
          "value": 0.15,
          "countries": [
            "RS"
          ]
        }
      ],
      "sync_status": "0",
      "create_time": "2021-06-29 10:04:29",
      "update_time": "2021-06-29 11:53:00"
    }
  ],
  "tag": "https://{domain}/mmpa?a=quality&event={EVENT}&conv_id={CLICK_ID}&currency={CURRENCY}&price={PRICE}"
}

{
  "total": 1,
  "items": [
    {
      "company_id": "1234123",
      "campaign_id": "1237123",
      "conversion_id": "12342",
      "currency_code": "USD",
      "price": 5,
      "attributed": 1,
      "conversion_repeat": 1,
      "modifiers": [
        {
          "id": "95eb301b-6aaf-42ad-a219-ccbd5f4d3d2b",
          "value": 1.2,
          "countries": [
            null
          ],
          "subid": [
            null
          ],
          "categories": [
            null
          ]
        }
      ],
      "modifier_type": "exact-value",
      "create_time": "2021-10-29 12:47:00",
      "update_time": "2021-10-30 14:27:26"
    }
  ]
}