Introduction
Datasources and destinations
- Find all the data sources available at www.catchr.io/integrations
- Find all the destinations available at www.catchr.io/destinations
Campaign Id Id of a Campaign. |
| ||||||
Campaign name Campaign name that will be displayed to the user |
| ||||||
Campaign Purchase Order A purchase order number, to be shown on your invoice, for your own personal organization. |
| ||||||
Campaign Objective Objective for a campaign. UNSET should not be used. |
| ||||||
Campaign Status Allowed values:'UNSET', 'ACTIVE', 'PAUSED', 'ARCHIVED', 'UNRECOGNIZED' |
| ||||||
Campaign Created At Date the Campaign was created. |
| ||||||
Campaign Updated At Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ |
| ||||||
Year Year such as 2017. |
| ||||||
Year Quarter Year and quarter. |
| ||||||
Year month Year and month. |
| ||||||
Year week Year and week. |
| ||||||
Date Year, month, and day. |
| ||||||
Year month day hour Year, month, day, and hour. |
| ||||||
Quarter of the year Quarter of the year |
| ||||||
Month of the year Month of the year |
| ||||||
Week of the year Week of the year |
| ||||||
Month and day Month and day |
| ||||||
Day of the week Week of the year |
| ||||||
Day of the month Day of the year |
| ||||||
Hour of the day Hour of the day |
| ||||||
Ad Set Id Id of an Ad Set. |
| ||||||
Ad Set Created At Date the Ad Set was created. |
| ||||||
Ad Set Start Date Date the ad set will start on. |
| ||||||
Ad Set End Date Date the ad set will end on. |
| ||||||
Ad Set Budget Amount Total budget for the ad set |
| ||||||
Ad Set Budget Type Allowed values: "DAILY", "LIFETIME" |
| ||||||
Ad Set Budget Currency Currency of the budget |
| ||||||
Ad Set name Ad Set name that will be displayed to the user |
| ||||||
Ad Set Status Allowed values:'ACTIVE', 'APPROVED', 'ARCHIVED', 'COMPLETED', 'PENDING_APPROVAL', 'READY', 'REJECTED' |
| ||||||
Ad Set Active Status Allowed values:'ACTIVE', 'PAUSED', 'ARCHIVED' |
| ||||||
Ad Set Cost Model Allowed values:'CPCL', 'CPM', 'CPC', 'UNSET' |
| ||||||
Ad Set Artist Promotion Name The artist promotion name of Ad Set |
| ||||||
Ad Set Artist Promotion Goal The artist promotion goal of Ad Set |
| ||||||
Ad Set Artist Promotion Target Type The artist promotion target type of Ad Set |
| ||||||
Ad Set Artist Promotion Target Id The artist promotion target id of Ad Set |
| ||||||
Ad Set Artist Promotion Conversion Tracking Event Type The artist promotion conversion tracking event type of Ad Set |
| ||||||
Ad Set Artist Promotion Conversion Event Window Duration The artist promotion target id of Ad Set |
| ||||||
Ad Set Reject Reason The Ad Set reject reason. |
| ||||||
Ad Set Serving Issues The Ad Set serving issues. |
| ||||||
Ad Set Bid Optimization Goal Allowed values:'UNSET', 'AD_COMPLETES', 'CLICKS', 'EVEN_IMPRESSION_DELIVERY', 'REACH' |
| ||||||
Ad Set Bid Strategy Allowed values:'UNSET', 'MAX_BID' |
| ||||||
Ad Set Bid Amount The ad set bid amount. |
| ||||||
Ad Set Version When an Ad Set is created or updated, it is assigned a new version. |
| ||||||
Ad Id Id of an Ad. |
| ||||||
Ad Created At Date the Ad was created. |
| ||||||
Ad Landing Page Domain URL the campaign will direct to |
| ||||||
Ad Clickthrough Url The link to the ads desired landing page activated by a button labelled CTA below and also the cover art image. |
| ||||||
Ad name Name given to identify your ad. |
| ||||||
Ad Status Allowed values: "ACTIVE", "PENDING", "PENDING_USER_APPROVAL", "PENDING_ADMIN_APPROVAL", "APPROVED", "REJECTED", "ARCHIVED", "UNRECOGNIZED" |
| ||||||
Ad Reject Reason Ad reject reason |
| ||||||
Ad brand name Brand name of the Ad. |
| ||||||
Ad Tagline Tagline of the Ad. |
| ||||||
Ad version Version of the Ad. |
| ||||||
Ad Asset Id The ID provided back when an upload url is requested. Note this does not mean it's processed successfully; you will need to check the status for that. |
| ||||||
Ad Companion Asset Id The ID provided back when an companion image upload url is requested. Note this does not mean its Processed successfully, you will need to check the status for that* bbbv , cv. |
| ||||||
Ad Asset Logo Id A unique identifier for an IMAGE asset. |
| ||||||
Ad Asset Canvas Id A unique identifier for an IMAGE or VIDEO asset with 9:16 aspect ratio. |
| ||||||
Image Asset Id Id of an image asset. |
| ||||||
Image Asset Name Name of an image asset. |
| ||||||
Image Asset Type Image Asset Type. |
| ||||||
Image Asset Status Status of an image asset. it can be READY, PROCESSING, WAITING_UPLOAD, PENDING_APPROVAL or ERROR. |
| ||||||
Image Asset URL URL of an image asset. |
| ||||||
Image Asset Created At Date the Image Asset was created. |
| ||||||
Image Asset Updated At Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ |
| ||||||
Image Asset Image Type The type of image asset. Allowed values: "COMPANION", "LOGO", "USER_UPLOADED_IMAGE"Example: "COMPANION" |
| ||||||
Image Asset File Type The file type of the image asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "JPEG", "PNG" |
| ||||||
Image Asset Aspect Ratio The aspect ratio of the asset with double precision. Example: 0.5625 |
| ||||||
Image Asset Width Width of an image asset. |
| ||||||
Image Asset Height Height of an image asset. |
| ||||||
Audio Asset Id Id of an Audio Asset. |
| ||||||
Audio Asset Name Name of an Audio Asset. |
| ||||||
Audio Asset Type Audio Asset Type. |
| ||||||
Audio Asset Status The current status of an asset throughout lifecycle processes. Allowed values: "ERROR", "PROCESSING", "READY", "WAITING_UPLOAD" Example: "READY" |
| ||||||
Audio Asset URL URL of asset. Will be either Google Cloud Storage URL or CDN URL depending on the asset type and the transcoding completion status. |
| ||||||
Audio Asset Audio Type The type of audio asset. Allowed values: "BACKGROUND_MUSIC", "STOCK_BACKGROUND_MUSIC", "USER_UPLOADED_AUDIO Example: "USER_UPLOADED_AUDIO" |
| ||||||
Audio Asset File Type The file type of the audio asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "MP3", "OGG", "WAV" |
| ||||||
Audio Asset Duration The duration of the asset. This value is populated as part of asset processing, and will be null until the asset is in ready state |
| ||||||
Audio Asset Created At Date the Audio Asset was created. |
| ||||||
Audio Asset Updated At Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ |
| ||||||
Video Asset Id Id of a Video Asset. |
| ||||||
Video Asset Name Name of a Video Asset. |
| ||||||
Video Asset Type Video Asset Type. |
| ||||||
Video Asset Status Status of a Video Asset. It can be READY, PROCESSING, WAITING_UPLOAD, PENDING_APPROVAL, REJECTED or ERROR. |
| ||||||
Video Asset URL URL of a Video Asset. |
| ||||||
Video Asset Created At Date the Video Asset was created. |
| ||||||
Video Asset Updated At Date the entity was updated. Time should be in ISO 8601 format using Coordinated Universal Time (UTC) with a zero offset: YYYY-MM-DDTHH:MM:SSZ |
| ||||||
Video Asset Duration Duration of a Video Asset in seconde. |
| ||||||
Video Asset Aspect Ratio The aspect ratio of the asset with double precision. Example: 0.5625 |
| ||||||
Video Asset Width Width of a video asset. |
| ||||||
Video Asset Height Height of a video asset. |
| ||||||
Video Asset File Type The file type of the video asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "MP4", "QUICKTIME" |
| ||||||
Video Asset Has Audio The file type of the video asset as defined by the 'file type' specification of the ISO base media file format standard. Allowed values: "MP4", "QUICKTIME" |
| ||||||
Video Asset Thumbnail URL URL of thumbnail image of the video asset. Example: "https://adstudio-video-preview-image.spotifycdn.com/123-preview" |
| ||||||
Clicks The number of impressions in which your ad was clicked (#) |
| ||||||
Completes The number of ads served that was played to the end (#) |
| ||||||
CTR The percentage of ads that were clicked (%) |
| ||||||
ECPM The average cost per 1,000 impressions |
| ||||||
ECPL The average cost per 1,000 completed listens - NOTE: Applies to active audio/CPCL campaigns only |
| ||||||
First Quartiles The percentage of users who listened or viewed a given percentage of the ad (%) |
| ||||||
Frequency The average number of times each person heard or viewed your ad (#) |
| ||||||
Impressions The number of times an ad has been successfully served (#) -- NOTE: The API reports on exact impressions, whereas the UI only reports impressions delivered within budgets |
| ||||||
Midpoints The number of users for which the ad played to the midpoint of the ads total length (#) |
| ||||||
Off Spotify Impressions The number of ads served off of Spotify (#) |
| ||||||
Paid Listens The number of listens for a CPCL campaign where a user did NOT skip the ad -- NOTE: Applies to active audio/CPCL campaigns only |
| ||||||
Paid Listens Frequency The average frequency for listens on a CPCL campaign -- NOTE: Applies to CPCL campaigns only |
| ||||||
Paid Listens Reach The number of unique users who had a paid listen for this CPCL campaign -- NOTE: Applies to active audio/CPCL campaigns only |
| ||||||
Third Quartiles The percentage of users who listened or viewed a given percentage of the ad (%) |
| ||||||
Reach The number of unique users who received your ad (#) |
| ||||||
Spend The total amount spent in this campaign, represented in micros -- i.e., multiplied by 10 to the power of 6 (#) |
| ||||||
Starts The number of times a user starts hearing/viewing your ad (#) |
| ||||||
Skips The number of times a user skips an ad -- NOTE: Skippable ads are currently supported in AU only (#) |
| ||||||
Extracted Date The date where the extraction take times. |
| ||||||
Platform Name Return the platform name |
|
.svg){kind=logo}