DIdisconetwork
Recommendations

Get Disco Advertiser Recommendations

Use the Disco Network advertiser recommendation engine to get the best offers for your customers in post-purchase experiences.

post/recommendations

Request

Headers

versionstring required

The version of the API you wish to use

Request body

Example request

{
  "user_details": {
    "email": "shopper@example.com",
    "first_name": "Monica",
    "last_name": "Stone",
    "phone": "+1 (415) 123-4567"
  },
  "order_details": {
    "cost_details": {
      "amount": 100,
      "currency_code": "USD"
    },
    "payment_type": "VISA"
  },
  "purchases": [
    {
      "type": "Electronics",
      "description": "Noise-cancelling headphones",
      "cost_details": {
        "amount": 100,
        "currency_code": "USD"
      }
    }
  ],
  "attributes": {
    "operating_system": "iOS",
    "operating_system_version": "18.3.2"
  },
  "shipping": {
    "address_line_1": "431 Main St.",
    "address_line_2": "Suite 2A",
    "city": "Miami",
    "state": "FL",
    "zip": "45231",
    "phone": "+1 (415) 123-4567"
  },
  "billing": {
    "address_line_1": "431 Main St.",
    "address_line_2": "Suite 2A",
    "city": "Miami",
    "state": "FL",
    "zip": "45231",
    "phone": "+1 (415) 123-4567"
  },
  "running_experiments": [
    {
      "name": "optimization_04",
      "version": 1
    }
  ]
}

Response

The request was successful, and the server has returned the requested resource in the response body.

session_idstring uuid required

Unique identifier used in the Disco system for events

recommendationsobject required

Each element here contains the details for a given offer. The keys here are the offer_id's found in the recommendation_groups.

recommendation_groupsobject required

Ordered groups of offer ids to display. Get details for each offer from recommendations object. By default there will be one group with the key "group_0" with the recommendations you need to power the ad serving experience.

recommendation_group_propertiesobject

A mapping from recommendation group id to properties describing how to display that group

Example response

{
  "session_id": "30576e99-fda5-41bc-b62c-65109ba47147",
  "recommendations": {
    "7c2d0ba1-9c53-4032-824d-72e49850ecc6": {
      "advertiser": {},
      "offer": {}
    }
  },
  "recommendation_groups": {
    "group_0": [
      {
        "insertion_order": 0,
        "insertion_id": "827d0-eniu29dbnf92",
        "offer_id": "7c2d0ba1-9c53-4032-824d-72e49850ecc6",
        "advertiser_id": "6d3f8745-9fde-47be-91fa-fbe09870f997"
      }
    ]
  },
  "running_experiments": [
    {
      "name": "optimization_04",
      "version": 1
    }
  ],
  "footer": {
    "attribution_details": {
      "copy": "Powered by",
      "disco_logo_url": "https://launcher.disconetwork.com/static/media/disco-logo-gray.01a8140f2bc1b025de45ba9950bc6341.svg",
      "target_url": "https://disconetwork.com"
    },
    "privacy_policy": {
      "copy": "Privacy Policy",
      "target_url": "https://www.disconetwork.com/privacy-policy"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.