Retrieve Target offers

Changed on
post/rest/v1/delivery

Request

  • Base URL: https://{clientCode}.tt.omtrdc.net
  • URL: https://{clientCode}.tt.omtrdc.net/rest/v1/delivery
  • Auth: none declared

Query parameters

clientstring required

The customer client code

sessionIdstring required

This is the sessionId that should be generated and maintained by the API user for the current session the user is a part of. The session ID can be any printable string except a space, question mark ( ? ), curly braces ( { } ), or a forward slash ( / ). It should be between 1 and 128 characters in length. <br><br> For a particular session, its value must stay the same across multiple requests for the same user since routing to a particular node in the edge cluster, which contains the user profile, is done using the sessionId. The session is active for 30 minutes on the server side. Therefore, you shouldn’t use a different sessionId for a particular tntId or thirdPartyId within 30 minutes of the last request made with the same tntId or thirdPartyId. Otherwise, changes to the profile could be inconsistent and unpredictable. <br><br>Furthermore, using the same sessionId with different tntId or thirdPartyId may cause unpredictable changes to the profiles.

Request body

requestIdstring

The request ID that will be returned in the response. In case it is not provided, an UUID is generated and returned automatically.

impressionIdstring

If not present it will be automatically generated (UUID). If present, second and subsequent requests with the same id will not increment impressions to activities/metrics. Similar to page id.

environmentIdinteger

Valid client environment id. If not specified host will be determined base on the provided host.

Response

Success

statusinteger
requestIdstring

ID of the processed request. If it's not sent in the request, a random ID (UUID) is generated and returned with the response.

idId (unresolved $ref)
clientstring

Client's code. The one which was sent in the request's path.

edgeHoststring

Cluster host name that served the response. Ideally, all subsequent requests should be made to that host.

Changes

  • eb7e7f0b1a83Revision changes
    • breaking

      the / response property's maxLength was increased from 128 to 256 for the response status

    • info

      the / request property's maxLength was increased from 128 to 256

  • a939481651bdRevision changes
    • breaking

      the //////// request property type changed from date-time to string

    • breaking

      the //////// request property type changed from string to object

    • breaking

      the //////// request property type changed from string to object

    • breaking

      the /// request property type changed from date-time to string

    • breaking

      the /// request property type changed from string to object

    • breaking

      the /// request property type changed from string to object

    • breaking

      the /////// request property type changed from date-time to string

    • breaking

      the /////// request property type changed from string to object

    • breaking

      the /////// request property type changed from string to object

    • breaking

      the //////// request property type changed from date-time to string

    • breaking

      the //////// request property type changed from string to object

    • breaking

      the //////// request property type changed from string to object

    • breaking

      the /// request property type changed from date-time to string

    • breaking

      the /// request property type changed from string to object

    • breaking

      the /// request property type changed from string to object

    • breaking

      the //////// request property type changed from date-time to string

    • breaking

      the //////// request property type changed from string to object

    • breaking

      the //////// request property type changed from string to object

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property ////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property ////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////

    • info

      added the new optional request property /////////