POST /forecast
Api key

Body

The specific forecast to create

  • assets array[string] Required

    The assets to forecast

  • campaignStartDate string Required

    The start date of the campaign

  • campaignEndDate string Required

    The end date of the campaign

  • segments array[string] Required

    The audience segments to include in the forecast

  • businessId string Required

    The ID of the business making the forecast request

Body

The specific forecast to create

  • assets array[string] Required

    The assets to forecast

  • campaignStartDate string Required

    The start date of the campaign

  • campaignEndDate string Required

    The end date of the campaign

  • segments array[string] Required

    The audience segments to include in the forecast

  • businessId string Required

    The ID of the business making the forecast request

Responses

  • 200 application/json

    The forecast created from the request

    Hide response attribute Show response attribute object
    • data array[object] Required

      The data generated from the forecast

      Hide data attributes Show data attributes object
      • asset_id string Required
      • campaign_start_date object Required
        Hide campaign_start_date attribute Show campaign_start_date attribute object
        • value string Required
      • campaign_end_date object Required
        Hide campaign_end_date attribute Show campaign_end_date attribute object
        • value string Required
      • reach integer Required
      • impressions integer Required
      • frequency number Required
      • demographics array[object] Required
        Hide demographics attributes Show demographics attributes object
        • lumos_segment_id string Required
        • segment_name string Required
        • penetration number Required
        • index number Required
      • segments array[object] Required
        Hide segments attributes Show segments attributes object
        • lumos_segment_id string Required
        • segment_name string Required
        • index number Required
  • 400 application/json

    Client error

    Hide response attribute Show response attribute object
    • message string Required

      A human readable error message
POST /forecast 
curl \
 --request POST 'https://client.spotlumos.com/forecast' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{"assets":["string"],"campaignStartDate":"string","campaignEndDate":"string","segments":["string"],"businessId":"string"}'
curl \
 --request POST 'https://client.spotlumos.com/forecast' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: multipart/form-data" \
 --form "assets[]=string" \
 --form "campaignStartDate=string" \
 --form "campaignEndDate=string" \
 --form "segments[]=string" \
 --form "businessId=string"
Request examples 
{
  "assets": [
    "string"
  ],
  "campaignStartDate": "string",
  "campaignEndDate": "string",
  "segments": [
    "string"
  ],
  "businessId": "string"
}
Response examples (200) 
{
  "data": [
    {
      "asset_id": "string",
      "campaign_start_date": {
        "value": "string"
      },
      "campaign_end_date": {
        "value": "string"
      },
      "reach": 42,
      "impressions": 42,
      "frequency": 42.0,
      "demographics": [
        {
          "lumos_segment_id": "string",
          "segment_name": "string",
          "penetration": 42.0,
          "index": 42.0
        }
      ],
      "segments": [
        {
          "lumos_segment_id": "string",
          "segment_name": "string",
          "index": 42.0
        }
      ]
    }
  ]
}
Response examples (400) 
{
  "message": "string"
}