v1

latestOpenAPI 3.1.02026-07-26374172.5 KB

Searching airchecks

This version of the aircheck API does not support the following features for searching and filtering processed airchecks:

Searching for promo codes in the creative body

To take advantage of these and other advanced features, you must continue to use the normal aircheck dashboard at https://app.magellan.ai/airchecks.

get/airchecks

Query parameters

brand_namestring required

The name of the airchecked brand.

start_datestring date required

The start of the date range to search. This should be in YYYY-MM-DD format, e.g. "2005-12-31".

end_datestring date required

The end of the date range to search. It must be after the start date. This should be in YYYY-MM-DD format, e.g. "2005-12-31".

podcast_titlestring

The title of the airchecked podcast.

aircheck_statusesstring[]

A comma-separated list of aircheck statuses to filter by. When omitted, all statuses are included. (Note: found is not a status you can filter by since it's an implicit status. You will see the status you filtered by within the matching_ads portion of the response.)

aircheck_tagsstring[]

A comma-separated list of aircheck tags to filter by. When omitted, all tags are included.

feed_typesstring[]

A comma-separated list of feed types to filter by. When omitted, all feed types are included.

regionsstring[]

A comma-separated list of ISO 3166-1 alpha-2 country codes to filter by. When omitted, all regions are included. Valid values can be found at https://www.iso.org/obp/ui/

aircheck_uidsstring[]

A comma-separated list of aircheck uids to filter by.

Response

200

status'waiting' | 'found' | 'no_episodes' | 'missing'

run_of_networkboolean

uidstring nullable

capture_window'on' | 'week_of' | 'month_of'

media_typesstring[]

regionstring

dynamic_insertionboolean

publishersstring[]

expected_ad_positionsstring[]

expected_ad_lengthinteger nullable

expected_promo_codestring nullable

podcast_titlestring

brand_namestring

expected_datestring

start_datestring

end_datestring

itunes_idinteger nullable

Example response

[
  {
    "uid": "123_aircheck",
    "media_types": [
      "podcast"
    ],
    "region": "US",
    "publishers": [
      "MyService"
    ],
    "expected_ad_length": 15,
    "expected_promo_code": "BUYMERCH",
    "podcast_title": "MyPodcast",
    "brand_name": "MyBrand",
    "expected_date": "2005-12-31",
    "start_date": "2005-12-26",
    "end_date": "2006-01-01",
    "itunes_id": 123456789,
    "aliases": {
      "brand": [
        "My Brand"
      ],
      "podcast": [
        "My Podcast"
      ],
      "network": [
        "My Publisher"
      ]
    },
    "matching_ads": [
      {
        "guid": "012345678-90ab-cdef-0123-456789abcdef",
        "link": "https://app.magellan.ai/shareable/permalink/to/ad",
        "audio_clip": "https://app.magellan.ai/permalink/to/ad/clip.mp3",
        "status": "matched",
        "total_ads": {
          "pre": 1,
          "post": 1
        },
        "impressions": {
          "total": 500,
          "within_capture_window": 100
        },
        "youtube_views": {
          "count": 100,
          "as_of": "2005-12-31"
        },
        "promo_code": {
          "found": true,
          "actual_codes": [
            "BUYMERCH"
          ],
          "usage_count": 10
        },
        "competitive_brands_flagged": [
          "MyCompetitor"
        ],
        "ad_stacking": {
          "stack_position": 2,
          "stack_size": 3
        },
        "brand_safety": {
          "flagged": true,
          "link_to_transcript": "https://app.magellan.ai/permalink/to/ad/transcript",
          "keyword_buckets_matched": [
            "profanity"
          ]
        },
        "episode_title": "I am AI, and so can you!",
        "publication_date": "2006-01-01 00:00:00",
        "download_date": "2006-01-01 00:00:00",
        "start_time": "00:00:30",
        "end_time": "00:01:00",
        "ad_length": 30,
        "ad_position_percentage": "3.67%",
        "ad_position_quarter": 1,
        "transcription": "Lorem ipsum dolor sit amet, consectetur adipiscing elit"
      }
    ]
  }
]