AI Search

Get Deal by ID

Use the API to fetch the complete configuration of a specific deal using its unique ID.

API Endpoint

GET https://apis.demand.ssp.inmobi.com/v1/deals?deal_id=<deal_id>

Parameters

Headers

Field Name Type Is mandatory (Y/N)? Description
Authorization String Y Bearer token for authentication (Bearer <token>)
X-USER-ID String Y The ID of the user making the request
X-INMOBI-ORG-ID String Y The organization ID associated with the user
Content-Type String Y Specifies the media type of the request body. Use: application/json

Query Parameters

Field Name Type Is mandatory (Y/N)? Description
deal_id String Y Unique identifier for the deal to fetch

All requests must include the headers: Authorization, X-USER-ID, and X-INMOBI-ORG-ID.

Sample Request

curl -X GET "https://apis.demand.ssp.inmobi.com/v1/deals?deal_id=4263509468" \
-H "Authorization: Bearer <your bearer token>" \
-H "X-USER-ID: <test app>" \
-H "X-INMOBI-ORG-ID: <your org id>" \
-H "Content-Type: application/json"

Sample Response

{
  "data": {
    "id": "4263509468",
    "name": "testdeal1",
    "seats": [
      {
        "id": "seat1"
      }
    ],
    "dspId": "cbab4104e7f14e2fbd2e21e96a8bf787",
    "dspName": "Aarki RTB",
    "startDate": "17/07/2025",
    "endDate": "18/07/2025",
    "dealType": "PREFERRED_DEAL",
    "dealFloor": 10,
    "dealFloorType": "STATIC",
    "dealFloorTolerance": "",
    "status": "UPCOMING",
    "isActive": false,
    "isDealSynced": false,
    "targeting": [
      {
        "targetingSegmentId": 30890,
        "geography": {
          "stateTargeting": {
            "states": [
              {
                "countryId": 128,
                "countryName": "Algeria",
                "stateIds": [
                  {
                    "id": 31207,
                    "name": "ADRAR"
                  }
                ]
              }
            ],
            "isIncl": true
          },
          "cityTargeting": {
            "cities": [
              {
                "countryId": 53,
                "countryName": "Germany",
                "cityIds": [
                  {
                    "id": 900611,
                    "name": "RHEINLAND-PFALZ - AACH"
                  }
                ]
              },
              {
                "countryId": 111,
                "countryName": "Belgium",
                "cityIds": [
                  {
                    "id": 49229,
                    "name": "OOST-VLAANDEREN - AALST"
                  },
                  {
                    "id": 49222,
                    "name": "VLAAMS-BRABANT - AARSCHOT"
                  }
                ]
              }
            ],
            "isIncl": true
          },
          "countryTargeting": {
            "countries": [
              {
                "id": 125,
                "name": "Afghanistan"
              }
            ],
            "isIncl": true
          }
        },
        "inventory": {
          "inventoryTypeTargeting": {
            "types": [
              {
                "id": "BROWSER",
                "name": "Browser"
              }
            ],
            "isIncl": true
          },
          "adTypeTargeting": {
            "types": [
              {
                "id": 1,
                "name": "Interstitial Video",
                "externalName": "Video"
              }
            ],
            "isIncl": true
          },
          "adSlotTargeting": {
            "slots": [
              {
                "id": 14,
                "name": "320x480"
              }
            ],
            "isIncl": true
          },
          "bundleTargeting": {
            "bundleIds": [
              "app/domain"
            ],
            "isIncl": true
          },
          "publisherTargeting": {
            "publishers": [
              "publisherwhitelist"
            ],
            "isIncl": true
          }
        },
        "audiences": {
          "csidFilterExpression": "[[5ace5190-db24-4392-8c88-4042491bca2e,7740e4bb-1963-4ed5-b4e2-c4a69a716e2f]]"
        },
        "devices": {
          "osVersions": [
            {
              "id": 3,
              "name": "Android"
            }
          ],
          "deviceIdPresent": 1
        }
      }
    ],
    "tracking": {
      "viewabilityPartners": {
        "ias": {
          "enableIas": true,
          "useInmobiIasTag": true,
          "usePartnerAdvertiserIdIas": false,
          "iasExternalTags": []
        }
      }
    },
    "margin": 20
  }
}

Error Codes

For more information, see Error Codes.

On This Page

Last Updated on: 18 Jul, 2025