Skip to main content
POST
Ad Request V2

Overview

Call the API to request an ad using the new V2 endpoint. This informs LynxSSP that an ad space is available and ready to be filled. The V2 endpoint provides a more detailed response and improved tracking.
For development or testing, use the sandbox endpoint below. Replace credentials and IDs with your actual values for production.

Authentication

All API requests require authentication using the lynx-key header. See Authentication for details.

Request Headers

string
default:"f9a3c4b7e2d84f85b3a2a1e3c9f071ac"
required
Unique authentication key for your account

Query Parameters

No query parameters are required for this endpoint.

Request Body

string
default:"venue1234"
required
The venue ID making the ad request. This should be your unique venue identifier.
string
default:"testing"
required
The screen ID within the venue making the ad request.
integer
default:"1770353697"
required
The UTC epoch seconds at which you expect to show the ad.

Response

string
required
Unique identifier for the ad request. Use this for tracking and proof of play.
integer
required
UTC epoch seconds when the ad is no longer valid to play.
string
required
The venue_id sent in the ad request.
string
required
The screen_id sent in the ad request.
integer
required
The ID of the creative returned for this ad request.
object
required
The advertisement object containing media and tracking information. Structure:
  • media (object):
    • url (string): URL to the ad media file (e.g., video).
    • width (integer): Width of the media in pixels.
    • height (integer): Height of the media in pixels.
    • duration (integer): Duration of the media in seconds.
    • bitrate (integer): Bitrate of the media in kbps.
    • type (string): MIME type of the media (e.g., “video/mp4”).
  • tracking (object):
    • impression (array of string): URLs to be triggered for ad impressions.
    • events (object): URLs to be triggered at each playback event. Contains:
      • start (array of url)
      • firstQuartile (array of url)
      • midpoint (array of url)
      • thirdQuartile (array of url)
      • complete (array of url)
    • error (array of string): URLs to be triggered on playback error.
The advertisement object includes media details and tracking URLs. Your player must trigger all impression and event URLs for proper reporting.

Empty Response

HTTP Status Code: 204 No Content If there are no ads available for the given parameters, the endpoint returns a successful response with no body content.

Example Request

This example uses sandbox credentials. For production, replace with your actual API key and venue/screen IDs.

Example Response