View Deal

GET /deals/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/deals/{id}

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

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
query Parameters
Arrow
Name
Description
fieldsstring
Fields parameter represents array of dimensions and measures. Dimensions are used to categorize, segment, and reveal the details of the data. Measures contain numeric, quantitative values that can be measured. At least one measure is required.


Example: fields=field1,field2,field3

Response status codes
Arrow
200 - OK
Arrow
Name
Description
items[ deal ]
An array of all created items.
Deals
Name
Description
archivednumber (integer)
Describes if a deal is archived. If a deal is archived its information can not be updated.


Example: 1
base_pricenumber (decimal)
Describes the base price that is set for the deal. Priority depends on field base_price_priority. Value must be between 0.01 and 10000.


Example: 2.24
base_price_priorityboolean
Describes if prices set in base_price or country_price have priority over the one sent as a query parameter.


Example: true

Possible values: true | false
budgetnumber (integer)
Value representing maximum total value a deal should earn. Minimum value 0, maximum 1000000.


Example: 2321
clickthroughboolean
Describes if a click event is required for a deal to be attributed.


Example: true

Possible values: true | false
company_idstring
Company ID


Example: 6197120
country_priceobject

Name
Description
keystring
Country code supported by the Ocamba platform (ISO 3166-1, 2 letter country codes).


Example: DE
valuenumber (decimal)
Value of price per country, minimum 0.1, maximum 10000.


Example: 12.53
create_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
descriptionstring
Deal Description


Example: The description of a Deal has the max of 2000 characters
device_priceobject

Name
Description
keystring
Device type, possible values are mobile and desktop.


Example: desktop
valuenumber (decimal)
Value of price per device, minimum 0, maximum 100.


Example: 12.53
effective_statusstring
Describes the status of the deal. Can be impacted by changes to partner.


Example: suspended
event_priceobject

Name
Description
keystring
Event name, maximum length 32 characters.


Example: click
valuenumber (decimal)
Value of price per event, minimum 0.1, maximum 10000.


Example: 12.53
frequency_capobject

Name
Description
max_valuenumber (int)
Describes the maximum number of time units that frequency cap will account for. Minimum 0, maximum 1.


Example: 12
per_unitstring
Describes the time unit used for frequency capping.


Example: day

Possible values: hour | day | week | month | session | campaign
idstring
Deals Unique Identifier


Example: 13472
namestring
Deal name, maximum 100 characters


Example: Example Name
partner_idstring
Valid partner id, supported by the Ocamba platform.


Example: 1000232
performance_conditionsobject

Name
Description
keystring
Event name, maximum length 32 characters.


Example: click
valuenumber (integer)
Value of score per event, minimum 1, maximum 100.


Example: 12
postbackstring
Deal url for clients to assign conversions to users.


Example: https://ocm.com/conv?click_id={OCMH_CLICK_ID}&price={PRICE}&currency={CURRENCY}
statsobject

Name
Description
costnumber (decimal)
Total cost for the deal.


Example: 11.1
revenuenumber (decimal)
Total revenue for the deal.


Example: 34.1
roinumber (decimal)
Return on investment, shown in percentage.


Example: 229.2
statusstring
Deal Status can be active or inactive. Default value is 'active'.


Example: active

Possible values: active | inactive
structurestring
Deal payment structure. Describes the basis on which the price is calculated.


Example: cpi

Possible values: cpc | cpm | cpi | cpl | cpe | cps | cpv | performance-based | subscription-based | flat-fee | hybrid
systemnumber (int)
Indicates if the deal is a system deal. A system deal is automatically added when installing the Hood application.


Example: 1
time_windownumber (integer)
Describes how much time in seconds can pass between a click event and attribution, every attribution after that time window will be marked as spam. Value of 0 means there is no limit. Minimum value 0, maximum value 2592000.


Example: 3600

Possible values: 3600 | 21600 | 43200 | 86400 | 604800 | 1209600 | 2592000 | 5184000 | 7776000
typestring
Deal type, can be ssp or dsp.


Example: ssp

Possible values: ssp | dsp
unique_conversionboolean
Toggles check if deal is unique. Uniqueness is determined by reference provided by user when attributing deal. Default value false.


Example: true
update_timedateTime
Timezone: GMT.


Example: 2021-10-29 15:40:10
totalinteger
A total number of items.


Example: 1
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
tip
1 If you don't know the deal id, list the deals to find it.
Response examples
Copied
Arrow
200 Arrow
  • 200
  • 200
  • 500
{
    "total": 1,
    "items": [
        {
            "id": "13694",
            "company_id": "6197120",
            "account_id": "6197120",
            "name": "Example",
            "status": "active",
            "effective_status": "active",
            "frequency_cap": {
              "max_value": 12,
              "per_unit": "week"
            },
            "time_window": 3600,
            "base_price": 1.122424,
            "system": 1,
            "base_price_priority": true,
            "country_price": {
                "  RS  ": 12.11241241
            },
            "postback": "https://ocm.com/conv?click_id={OCMH_CLICK_ID}&price={PRICE}&currency={CURRENCY}&ref={REFERENCE}&event={EVENT}&device={DEVICE}&session_id={SESSION_ID}",
            "is_default": 0,
            "create_time": "2023-07-31 06:12:31",
            "update_time": "2023-07-31 11:13:29"
        }
    ]
}

{
  "total": 1,
  "items": [
    {
      "id": "13472",
      "company_id": "6197120",
      "partner_id": "1000232",
      "name": "Example Name",
      "description": "The description of a Deal has the max of 2000 characters",
      "status": "active",
      "effective_status": "suspended",
      "type": "ssp",
      "structure": "cpi",
      "postback": "https://ocm.com/conv?click_id={OCMH_CLICK_ID}&price={PRICE}&currency={CURRENCY}",
      "frequency_cap": {
        "max_value": 12,
        "per_unit": "day"
      },
      "clickthrough": true,
      "time_window": 3600,
      "base_price": 2.24,
      "country_price": {
        "key": "DE",
        "value": 12.53
      },
      "event_price": {
        "key": "click",
        "value": 12.53
      },
      "device_price": {
        "key": "desktop",
        "value": 12.53
      },
      "base_price_priority": true,
      "budget": 2321,
      "unique_conversion": true,
      "performance_conditions": {
        "key": "click",
        "value": 12
      },
      "system": 1,
      "stats": {
        "roi": 229.2,
        "revenue": 34.1,
        "cost": 11.1
      },
      "archived": 1,
      "create_time": "2021-10-29 15:40:10",
      "update_time": "2021-10-29 15:40:10"
    }
  ]
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}