Skip to main content

Dashboard API

The Dashboard API allows you to create and manage Dashboard configurations.

With IQM's Dashboards you can monitor your Campaigns' real-time performance at a glance and customize the filters and metrics by which those analytics are generated.

info

Dashboards are just one of your reporting and analytics tools. Refer to the Reports API Guidelines and Insights API Guidelines for in-depth Reports and Insights available on the IQM platform.

Learn more about Dashboards with our Help Center articles.

Authentication​

Use the following header parameters for all requests:

Headers
Authentication
string required		Authentication bearer token
See Authentication Guide
X-IAA-OW-ID
integer required		Organization Workspace ID Header

Dashboard Details​

Dashboard Resource Properties​

Resource Properties
id
integer		Dashboard ID
value
integer		Dashboard value (timestamp)
label
string		Dashboard name
created
integer		Creation timestamp
modifiedDate
string		Last modified date
data
object		Dashboard configuration data
data object properties
lastModified
integer		Last modified timestamp
filters
object		Dashboard filter settings
filters object properties
search
string		Search filter value
status
string		Status filter (e.g., running, all)
timezone
object		Timezone settings with id, name, and label
tableLevel
string		Table level view (e.g., campaigns, insertionOrders)
campaignIds
array		List of Campaign IDs
campaignTypes
array		List of Campaign Type IDs
creativeTypes
array		List of Creative Type IDs
ioBudgetTypes
array		List of IO Budget Type IDs
advertisersOwIds
string		Comma separated Advertiser Organization Workspace IDs
insertionOrderIds
array		List of Insertion Order IDs
sortingCampaignsColumns
array		List of column keys for Campaign table sorting
sortingExchangesColumns
array		List of column keys for Exchange table sorting
sortingWorkspacesColumns
array		List of column keys for Workspace table sorting
sortingAdvertisersColumns
array		List of column keys for Advertiser table sorting
sortingInsertionOrdersColumns
array		List of column keys for Insertion Order table sorting
sidebar
object		Sidebar graph settings
sidebar object properties
reportGraph
object		Report graph with metric and dimension
barAndLineGraph
object		Bar and line graph with metric1 and metric2

Dashboard List​

GET

Get a list of your Dashboard configurations. See resource properties for details.

A Dashboard id can be used for the Update Dashboard and Delete Dashboard endpoints.

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 1,
    "filteredRecords": 1,
    "items": [
      {
        "data": {
          "filters": {
            "search": "test",
            "status": "running",
            "timezone": {
              "id": 29,
              "name": "US/Eastern",
              "label": "US/Eastern"
            },
            "tableLevel": "campaigns",
            "campaignIds": [],
            "campaignTypes": [1],
            "creativeTypes": [11, 13, 14, 17],
            "ioBudgetTypes": [1],
            "advertisersOwIds": "204777,204778",
            "insertionOrderIds": [],
            "sortingCampaignsColumns": [
              "campaignId",
              "campaignName",
              "ioName",
              "organizationName",
              "status",
              "creativesCount",
              "startTime",
              "endTime",
              "budgetDay",
              "budgetTotal",
              "maxBid",
              "spent",
              "percentageOfTotalSpent",
              "impressions",
              "clicks",
              "CTR",
              "eCPM",
              "VCR",
              "winRate"
            ],
            "sortingExchangesColumns": [
              "exchangeId",
              "exchangeName",
              "impressions",
              "clicks",
              "winRate",
              "spent",
              "workspaceSpent",
              "platformSpent"
            ],
            "sortingWorkspacesColumns": [
              "workspaceId",
              "workspaceName",
              "budgetTotal",
              "budgetDay",
              "impressions",
              "clicks",
              "CTR",
              "winRate",
              "VCR",
              "spent",
              "workspaceSpent",
              "platformSpent"
            ],
            "sortingAdvertisersColumns": [
              "owId",
              "organizationName",
              "budgetTotal",
              "budgetDay",
              "impressions",
              "clicks",
              "CTR",
              "winRate",
              "VCR",
              "spent",
              "workspaceSpent",
              "platformSpent"
            ],
            "sortingInsertionOrdersColumns": [
              "ioId",
              "ioName",
              "organizationName",
              "ioStatusId",
              "campaignsCount",
              "ioStartTime",
              "ioEndTime",
              "ioTotalBudget",
              "ioPacingPercentage",
              "spent",
              "impressions",
              "clicks"
            ]
          },
          "sidebar": {
            "reportGraph": {
              "metric": "CTR",
              "dimension": "campaign"
            },
            "barAndLineGraph": {
              "metric1": "impressions",
              "metric2": "CTR"
            }
          },
          "lastModified": 1770125234
        },
        "created": 1770125235,
        "modifiedDate": "2026-02-03T13:27:15.431+00:00",
        "id": 1081,
        "label": "My Dashboard"
      }
    ]
  }
}

Get Campaign Goal AI Graph Data​

GET

Get a Campaign's Goal AI performance data.

Path Parameters
campaignId
integer required		Campaign ID
Response Properties
average
number		Average KPI value
withAI
number		KPI value with AI
withoutAI
number		KPI value without AI
lift
number		Lift percentage
graphData
array of objects		Graph data points
graphData object properties
date
integer		Timestamp date
actualKPI
number		Actual KPI value
campaignOptimization
object		Campaign optimization details
campaignOptimization object properties
aiObjectiveId
integer		AI Objective ID
aiGoalId
integer		AI Goal ID
aiTargetKpi
number		AI target KPI value
Response 200
{
  "success": true,
  "data": {
    "average": 88.0,
    "withAI": 20.45,
    "withoutAI": 68.45,
    "lift": 51.01,
    "graphData": [
      {
        "date": 12399999000,
        "actualKPI": 45.34
      },
      {
        "date": 12399989000,
        "actualKPI": 88.34
      }
    ],
    "campaignOptimization": {
      "aiObjectiveId": 2,
      "aiGoalId": 10,
      "aiTargetKpi": 60.0
    }
  }
}

Get Campaign Goal AI Optimization Activity​

GET
GET

Get a Campaign's Goal AI optimization activity log.

Path Parameters
campaign_id
integer required		Campaign ID
Query Parameters
dayEpoch
integer required		Epoch day to filter activities
searchField
string required		Filter results by search field
pageNo
integer required		Page number of retrieved data, default value: 1
noOfEntries
integer required		Number of entries returned per page, default: 50
fileType
string required		File type for download, values: csv (only for download endpoint)
Response Properties
activities
array of objects		List of optimization activities
activities object properties
date
string		Date of activity
time
string		Time of activity
action
string		Action performed
dimension
string		Dimension affected
value
string		New value set
timeEpoch
integer		Epoch time of activity
Response 200
{
  "success": true,
  "data": {
    "activities": [
      {
        "date": "2025-11-12",
        "time": "12:20:07",
        "action": "Spent Ratio Updated",
        "dimension": "Zip Code: 10796",
        "value": "54%",
        "timeEpoch": 1762930207
      },
      {
        "date": "2025-11-12",
        "time": "12:20:07",
        "action": "Spent Ratio Updated",
        "dimension": "City: Brooklyn, NY",
        "value": "87%",
        "timeEpoch": 1762930207
      },
      {
        "date": "2025-11-12",
        "time": "12:20:07",
        "action": "Spent Ratio Updated",
        "dimension": "Exchange: Pubmatic",
        "value": "24%",
        "timeEpoch": 1762930207
      }
    ]
  }
}
Response 200
{
  "success": true,
  "data": {
    "url": "https://url.sample.com"
  }
}

Dashboard Management​

Create Dashboard​

POST

Create and store a Dashboard configuration. See resource properties for request schema.

Request Schema
{
  "label": "My Dashboard",
  "id": "",
  "value": 1770214546527,
  "data": {
    "filters": {
      "search": "",
      "status": "running",
      "timezone": {
        "id": 29,
        "name": "US/Eastern",
        "label": "US/Eastern"
      },
      "tableLevel": "campaigns",
      "campaignIds": [],
      "campaignTypes": [1],
      "creativeTypes": [11, 13, 14, 17],
      "ioBudgetTypes": [1],
      "advertisersOwIds": "200058,200062",
      "insertionOrderIds": [],
      "sortingCampaignsColumns": [
        "campaignId",
        "campaignName",
        "ioName",
        "organizationName",
        "status",
        "startTime",
        "endTime",
        "budgetDay",
        "budgetTotal",
        "maxBid",
        "spent",
        "impressions",
        "clicks",
        "CTR",
        "eCPM",
        "VCR",
        "winRate"
      ],
      "sortingExchangesColumns": [
        "exchangeId",
        "exchangeName",
        "impressions",
        "clicks",
        "winRate",
        "spent"
      ],
      "sortingWorkspacesColumns": [
        "workspaceId",
        "workspaceName",
        "budgetTotal",
        "budgetDay",
        "impressions",
        "clicks",
        "CTR",
        "winRate",
        "VCR",
        "spent"
      ],
      "sortingAdvertisersColumns": [
        "owId",
        "organizationName",
        "budgetTotal",
        "budgetDay",
        "impressions",
        "clicks",
        "CTR",
        "winRate",
        "VCR",
        "spent"
      ],
      "sortingInsertionOrdersColumns": [
        "ioId",
        "ioName",
        "organizationName",
        "ioStatusId",
        "campaignsCount",
        "ioStartTime",
        "ioEndTime",
        "ioTotalBudget",
        "spent",
        "impressions",
        "clicks"
      ]
    },
    "sidebar": {
      "reportGraph": {
        "metric": "CTR",
        "dimension": "campaign"
      },
      "barAndLineGraph": {
        "metric1": "impressions",
        "metric2": "CTR"
      }
    },
    "lastModified": 1770125234
  }
}

Response 200
{
  "success": true,
  "data": {
    "message": "My Dashboard has been saved"
  }
}

Update Dashboard​

PUT

Update a Dashboard by ID. See resource properties for request schema.

Path Parameter
dashboardId
integer		Dashboard ID
Request Sample
{
  "label": "My Dashboard Updated",
  "id": 224,
  "value": 1770214546527,
  "data": {
    "filters": {
      "search": "",
      "status": "running",
      "timezone": {
        "id": 29,
        "name": "US/Eastern",
        "label": "US/Eastern"
      },
      "tableLevel": "campaigns",
      "campaignIds": [],
      "campaignTypes": [1],
      "creativeTypes": [11, 13, 14, 17],
      "ioBudgetTypes": [1],
      "advertisersOwIds": "200058,200062",
      "insertionOrderIds": [],
      "sortingCampaignsColumns": [
        "campaignId",
        "campaignName",
        "ioName",
        "organizationName",
        "status",
        "startTime",
        "endTime",
        "budgetDay",
        "budgetTotal",
        "maxBid",
        "spent",
        "impressions",
        "clicks",
        "CTR",
        "eCPM",
        "VCR",
        "winRate"
      ],
      "sortingExchangesColumns": [
        "exchangeId",
        "exchangeName",
        "impressions",
        "clicks",
        "winRate",
        "spent"
      ],
      "sortingWorkspacesColumns": [
        "workspaceId",
        "workspaceName",
        "budgetTotal",
        "budgetDay",
        "impressions",
        "clicks",
        "CTR",
        "winRate",
        "VCR",
        "spent"
      ],
      "sortingAdvertisersColumns": [
        "owId",
        "organizationName",
        "budgetTotal",
        "budgetDay",
        "impressions",
        "clicks",
        "CTR",
        "winRate",
        "VCR",
        "spent"
      ],
      "sortingInsertionOrdersColumns": [
        "ioId",
        "ioName",
        "organizationName",
        "ioStatusId",
        "campaignsCount",
        "ioStartTime",
        "ioEndTime",
        "ioTotalBudget",
        "spent",
        "impressions",
        "clicks"
      ]
    },
    "sidebar": {
      "reportGraph": {
        "metric": "CTR",
        "dimension": "campaign"
      },
      "barAndLineGraph": {
        "metric1": "impressions",
        "metric2": "CTR"
      }
    },
    "lastModified": 1770125234
  }
}

Response 200
{
  "success": true,
  "data": {
    "message": "My Dashboard Updated has been saved"
  }
}

Delete Dashboard​

DELETE

Delete a Dashboard.

Query Parameter
id
integer		Dashboard ID
Response 200
{
  "success": true,
  "data": {
    "message": "My Dashboard has been deleted"
  }
}

Dashboard Reports​

Create custom Reports or generate tailored Insights Reports from the Dashboard.

Dashboard Reports Resource Properties​

Resource Properties
clicks
integer		The number of times a user clicked on an ad
totalCount
integer		The number of records available in response as per the filtering applied in the request
winRate
integer		Percentage of impressions bid on and won
logoUrl
string		Logo URL
avatarUrl
string		Avatar URL
budgetDay
integer		Daily budget for Campaign serving daily
budgetSpent
integer		Budget spent
ioTotalBudget
integer		Insertion Order total budget
budgetTotal
integer		Campaign total budget
Note: can be null if fixed daily budget, start time, and end time are provided
dataCost
integer		Data cost applied on Campaigns of given Customer
mediaBudget
integer		Media budget
owId
integer		Organization Workspace ID
orgId
integer		Organization ID
impressions
integer		Impressions
industry
integer		Industry ID
mediaSpent
integer		Actual amount spent by an Advertiser (does not include dataCost or prebidCost
spent
integer		Amount spent
workspaceSpent
integer		Workspace spent
platformSpent
integer		Platform spent
customerSpent
integer		Customer spent
platformMediaEarning
integer		Platform media earning
platformBidShadingEarning
integer		Platform bid shading earning
platformTotalEarning
integer		Platform total earning
workspaceMediaEarning
integer		Workspace media earning
workspaceBidShadingEarning
integer		Workspace bid shading earning
workspaceTotalEarning
integer		Workspace total earning
organizationBidShadingSaving
integer		Organization bid shading saving
platformEarning
integer		Platform earning
workspaceEarning
integer		Workspace earning
organizationName
integer		Organization name
companySize
integer		Company size ID
workspaceName
integer		Workspace name
workspaceId
integer		Workspace ID
workspaceDomain
integer		Workspace domain
workspaceOrganizationName
integer		Workspace Organization name
bidImpressions
integer		Bid on impressions count
startCount
integer		Ad viewing metric, video start
firstCount
integer		Ad viewing metric, video first quarter
midCount
integer		Ad viewing metric, video midpoint
thirdCount
integer		Ad viewing metric, video last quarter
completeCount
integer		Ad viewing metric, video completed
audioVideoActualBids
integer		Audio/video actual bids
audioVideoActualImpressions
integer		Audio/video actual impressions
eCPC
integer		Effective cost per click
totalECPC
integer		Total effective cost per click
eCPM
integer		Effective cost per mille
totalECPM
integer		Total effective cost per mille
eCPI
integer		Effective cost per install
eCPCV
integer		Effective cost per completed view
eCPV
integer		Effective cost per visit
dailyImpression
integer		Daily impressions
totalAttributedConversion
integer		The number of Conversions that are attributed to a specific Campaign based on the Attribution model
totalAttributedViewThroughConversion
integer		The number of Conversions that occurred after a user viewed an ad but did not click on it
totalAttributedClickThroughConversion
integer		The number of Conversions that occurred after a user clicked on an ad
costPerAttributedConversion
integer		Cost per attributed Conversion
totalAttributedConversionRate
integer		Total attributed Conversion rate
conversionCount
integer		Conversion count
conversionValue
integer		Conversion value
conversionCPA
integer		Conversion CPA
conversionRate
integer		Conversion rate
reach
integer		The number of unique individuals exposed to an ad, does not count repeat views
frequency
integer		The average number of times each user was exposed to an ad
date
integer		Date
campaignId
integer		Campaign ID
campaignName
string		Campaign name
maxBid
integer		Max bid of budget for serving
baseBid
integer		Base value on which bid modifiers are applied
startTime
integer		Unix epoch timestamp, in milliseconds
endTime
integer		Unix epoch timestamp, in milliseconds
ioStartTime
integer		Unix epoch timestamp of IO start time, in milliseconds
ioEndTime
integer		Unix epoch timestamp of IO end time, in milliseconds
campaignType
string		Campaign Type
status
string		Status
campaignTimezone
string		Campaign timezone
creativeType
string		Creative Type
budgetPacing
boolean		Budget is spent equally every hour: true
isCampaignFromNewPlatform
boolean		Indicates if Campaign is from the old platform
percentageOfTotalSpent
integer		Percentage of total spent
vldInsightsCost
integer		VLD Insights cost
workspaceVLDInsightsEarnings
integer		Workspace VLD Insights earnings
platformVLDInsightsEarnings
integer		Platform VLD Insights earnings
pldInsightsCost
integer		PLD Insights cost
workspacePLDInsightsEarnings
integer		Workspace PLD Insights earnings
platformPLDInsightsEarnings
integer		Platform PLD Insights earnings
slsInsightsCost
integer		SLS Insights cost
workspaceSLSInsightsEarnings
integer		Workspace SLS Insights earnings
platformSLSInsightsEarnings
integer		Platform SLS Insights earnings
uowId
integer		User Organization Workspce ID
audioVideoViewed
integer		Audio/video viewed
ioId
integer		Insertion Order ID
ioName
string		Insertion Order name
ioTimezone
integer		Insertion Order timezone
ioBudgetTypeId
integer		Insertion Order Budget Type ID
ioStatusId
integer		Insertion Order Status ID
ioBudgetDistributionMethod
integer		IO Budget Distribution Method
pacingPercentage
integer		Pacing percentage
actualSpent
integer		Actual spent
expectedSpent
integer		Expected spent
campaignDuration
integer		Campaign duration
remainingDuraion
integer		Campaign remaining duration
dailyPacingPercentage
integer		Daily pacing percentage
expectedDailySpent
integer		Expected daily spent
actualDailySpent
integer		Actual daily spent
budgetTypeId
integer		Budget Type ID
campaignTypeId
integer		Campaign Type ID
isEligibleForVLDInsightsReport
boolean		Indicates whether Campaign is eligible for VLD Insights Report: true
isEligibleForPLDInsightsReport
boolean		Indicates whether Campaign is eligible for PLD Insights Report: true
targetImpression
integer		Impressions target
creativesCount
integer		Creatives count
campaignPriority
integer		Campaign priority
bidModelDataId
integer		Bid Model data ID
campaignsCount
integer		Number of Campaigns associated with IO
ioTotalImpressions
integer		IO total impressions
ioPacingPercentage
integer		IO pacing percentage
ioActualSpent
integer		IO actual spent
ioExpectedSpent
integer		IO expected spent
ioDuration
integer		IO duration
ioRemainingDuraiton
integer		IO remaining duration
exchangeId
integer		Exchange ID
exchangeName
string		Exchange name
autoSumIoTotalBudget
boolean		If true Keeps IO budget same as total budget of all included Campaigns
isAutoSumIoTotalBudget
boolean		If true Keeps IO budget same as total budget of all included Campaigns
budgetTotalCombined
integer		Combined total budgets of all Campaigns associated with an IO
budgetDayCombined
integer		Combined daily budgets of all Campaigns associated with an IO
ioTotalBudgetCombined
integer		Combined total budgets of selected IOs
CTR
integer		Click-through rate
VCR
integer		Video completion rate
CVR
integer		Conversion rate

Workspace Report​

POST

Get aggregated Campaign performance metrics grouped by Workspace. Supports AGGREGATED, AGGREGATED_LIST, and AGGREGATED_TOTAL request types.

Request Schema
pagination
object		Pagination settings
pagination object properties
pageNo
integer		Page number, default: 1
noOfEntries
integer		Entries per page, default: 200
sort
object		Sorting settings
sort object properties
field
string		Sort by field, default: impressions
order
string		Sort order: ASC or DESC
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
creativeTypeIds
array of integers		Creative Type IDs
campaignTypeIds
array of integers		Campaign Type IDs
verticalIds
array of integers		Vertical IDs
campaignStatusList
array of strings		Campaign statuses (e.g., running, paused)
requestType
string required		AGGREGATED, AGGREGATED_LIST, or AGGREGATED_TOTAL
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 200
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000,
    "searchField": "",
    "creativeTypeIds": [11, 13, 14, 17],
    "campaignTypeIds": [1],
    "verticalIds": [],
    "campaignStatusList": ["running"]
  },
  "requestType": "AGGREGATED"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 4,
    "filteredRecords": 4,
    "recordsTotal": {
      "filteredRecordsTotal": 4,
      "impressions": 105709,
      "clicks": 99,
      "mediaSpent": 1534.25,
      "CTR": 0.094,
      "winRate": 13.52,
      "spent": 1837.82,
      "VCR": 0,
      "dataCost": 18.44,
      "thirdPartyCost": 2.75,
      "workspaceSpent": 623.6,
      "platformSpent": 541.08,
      "workspaceMediaEarning": 512.3,
      "platformMediaEarning": 425.1,
      "organizationBidShadingSaving": 0,
      "totalAttributedConversion": 5,
      "totalAttributedViewThroughConversion": 2,
      "totalAttributedClickThroughConversion": 3,
      "costPerAttributedConversion": 367.56,
      "totalAttributedConversionRate": 0.0047,
      "prebidCost": 0,
      "pldInsightsCost": 12.33,
      "slsInsightsCost": 5.1,
      "vldInsightsCost": 8.75,
      "aqInsightsCost": 3.2,
      "adServingCost": 2.75,
      "platformTotalEarning": 425.1,
      "platformPLDInsightsEarnings": 10,
      "platformSLSInsightsEarnings": 4.2,
      "platformVLDInsightsEarnings": 7.5,
      "platformBidShadingEarning": 0,
      "platformAQInsightsEarnings": 2.8,
      "workspaceTotalEarning": 512.3,
      "workspacePLDInsightsEarnings": 2.33,
      "workspaceSLSInsightsEarnings": 0.9,
      "workspaceVLDInsightsEarnings": 1.25,
      "workspaceBidShadingEarning": 0,
      "workspaceAQInsightsEarnings": 0.4
    },
    "recordsList": [
      {
        "owId": 200058,
        "workspaceId": 1053,
        "workspaceName": "stageadv1",
        "organizationName": "Test Organisation - Alpha",
        "budgetDay": 65.69,
        "budgetTotal": 1000,
        "impressions": 47326,
        "clicks": 42,
        "mediaSpent": 638.47,
        "CTR": 0.0886,
        "winRate": 20.01,
        "spent": 765.72,
        "VCR": 0,
        "dataCost": 8.2,
        "workspaceSpent": 253.4,
        "platformSpent": 210.05,
        "workspaceMediaEarning": 210.3,
        "platformMediaEarning": 175.22,
        "organizationBidShadingSaving": 0,
        "totalAttributedConversion": 3,
        "costPerAttributedConversion": 255.24,
        "totalAttributedConversionRate": 0.0063
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 200
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000,
    "searchField": "",
    "campaignStatusList": []
  },
  "requestType": "AGGREGATED_LIST"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 4,
    "filteredRecords": 4,
    "recordsList": [
      {
        "owId": 200058,
        "workspaceId": 1053,
        "workspaceName": "stageadv1",
        "organizationName": "Test Organisation - Alpha",
        "budgetDay": 65.69,
        "budgetTotal": 1000,
        "budgetDayCombined": 130.5,
        "budgetTotalCombined": 2000,
        "impressions": 47326,
        "clicks": 42,
        "mediaSpent": 638.47,
        "CTR": 0.0886,
        "winRate": 20.01,
        "spent": 765.72,
        "VCR": 0,
        "dataCost": 8.2,
        "thirdPartyCost": 2.75,
        "workspaceSpent": 253.4,
        "platformSpent": 210.05,
        "workspaceMediaEarning": 210.3,
        "platformMediaEarning": 175.22,
        "organizationBidShadingSaving": 0,
        "totalAttributedConversion": 3,
        "totalAttributedViewThroughConversion": 1,
        "totalAttributedClickThroughConversion": 2,
        "costPerAttributedConversion": 255.24,
        "totalAttributedConversionRate": 0.0063,
        "prebidCost": 0,
        "pldInsightsCost": 6.5,
        "slsInsightsCost": 2.1,
        "vldInsightsCost": 4.25,
        "aqInsightsCost": 1.6,
        "adServingCost": 1.2,
        "platformTotalEarning": 175.22,
        "platformPLDInsightsEarnings": 5.4,
        "platformSLSInsightsEarnings": 1.8,
        "platformVLDInsightsEarnings": 3.6,
        "platformBidShadingEarning": 0,
        "platformAQInsightsEarnings": 1.4,
        "workspaceTotalEarning": 210.3,
        "workspacePLDInsightsEarnings": 1.1,
        "workspaceSLSInsightsEarnings": 0.3,
        "workspaceVLDInsightsEarnings": 0.65,
        "workspaceBidShadingEarning": 0,
        "workspaceAQInsightsEarnings": 0.2
      }
    ]
  }
}
Request Sample
{
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000
  },
  "requestType": "AGGREGATED_TOTAL"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 0,
    "filteredRecords": 0,
    "recordsTotal": {
      "filteredRecordsTotal": 4,
      "impressions": 105709,
      "clicks": 99,
      "mediaSpent": 1534.25,
      "CTR": 0.094,
      "winRate": 13.52,
      "spent": 1837.82,
      "VCR": 0,
      "dataCost": 18.44,
      "thirdPartyCost": 2.75,
      "workspaceSpent": 623.6,
      "platformSpent": 541.08,
      "workspaceMediaEarning": 512.3,
      "platformMediaEarning": 425.1,
      "organizationBidShadingSaving": 0,
      "totalAttributedConversion": 5,
      "totalAttributedViewThroughConversion": 2,
      "totalAttributedClickThroughConversion": 3,
      "costPerAttributedConversion": 367.56,
      "totalAttributedConversionRate": 0.0047,
      "prebidCost": 0,
      "pldInsightsCost": 12.33,
      "slsInsightsCost": 5.1,
      "vldInsightsCost": 8.75,
      "aqInsightsCost": 3.2,
      "adServingCost": 2.75,
      "platformTotalEarning": 425.1,
      "platformPLDInsightsEarnings": 10,
      "platformSLSInsightsEarnings": 4.2,
      "platformVLDInsightsEarnings": 7.5,
      "platformBidShadingEarning": 0,
      "platformAQInsightsEarnings": 2.8,
      "workspaceTotalEarning": 512.3,
      "workspacePLDInsightsEarnings": 2.33,
      "workspaceSLSInsightsEarnings": 0.9,
      "workspaceVLDInsightsEarnings": 1.25,
      "workspaceBidShadingEarning": 0,
      "workspaceAQInsightsEarnings": 0.4
    }
  }
}
warning

This version of the API is deprecated. Refer to the v4 endpoint for the latest API functionality.

POST

Get a Report on a Campaign's performance by Workspace and supported filters.

Request Schema
startDate
string		Unix epoch timestamp, in milliseconds
endDate
string		Unix epoch timestamp, in milliseconds
timezoneId
integer		Timezone ID
campaignStatus
string		Campaign status
creativeTypeIds
string		Comma separated Creative Type IDs
searchField
string		Filter results by search field
sortBy
string		Sort results by field, default: impressions
order
string		Sorts by ascending (ASC) or descending (DESC)
owIds
string		Comma separated Organization Workspace IDs
pageNo
integer		Page number of retrieved data, default: 1
noOfEntries
integer		Number of entries returned per page, default: 50
resultType
string		Only total data in response (total) or only list of reports in response (data), both if not provided
Request Sample
{
  "startDate": "1660834800000",
  "endDate": "1660834800001",
  "timezoneId": 1,
  "campaignStatus": "all",
  "creativeTypeIds": "",
  "searchField": "",
  "sortBy": "impressions",
  "order": "DESC",
  "owIds": "1,2,3,4",
  "pageNo": 1,
  "noOfEntries": 50,
  "resultType": "total"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 57,
    "filteredRecords": 57,
    "recordsTotal": {
      "clicks": 0,
      "totalCount": 57,
      "winRate": 0,
      "budgetDay": 0,
      "budgetTotal": 0,
      "impressions": 0,
      "mediaSpent": 0,
      "spent": 0,
      "workspaceSpent": 0,
      "platformSpent": 0,
      "platformMediaEarning": 0,
      "workspaceMediaEarning": 0,
      "organizationBidShadingSaving": 0,
      "CTR": 0,
      "VCR": 0,
      "CVR": 0
    }
  }
}

IO Report​

POST

Get IO (Insertion Order) level aggregated performance report data including core metrics, pacing, reach/frequency, insights earnings, and conversions. Supports AGGREGATED, AGGREGATED_LIST, and AGGREGATED_TOTAL request types.

Request Schema
pagination
object		Pagination settings
pagination object properties
pageNo
integer		Page number, default: 1
noOfEntries
integer		Entries per page, default: 50
sort
object		Sorting settings
sort object properties
field
string		Sort by field, default: impressions
order
string		Sort order: ASC or DESC
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
ioIds
array of integers		Insertion Order IDs
campaignBudgetTypeIds
array of integers		Budget Type IDs
campaignStatusList
array of strings		Campaign statuses (e.g., running, paused, pending)
requestType
string required		AGGREGATED, AGGREGATED_LIST, or AGGREGATED_TOTAL
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 50
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000,
    "searchField": "",
    "ioIds": [1001, 1002],
    "campaignBudgetTypeIds": [1, 2],
    "campaignStatusList": ["running", "paused", "pending"]
  },
  "requestType": "AGGREGATED"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 2,
    "filteredRecords": 2,
    "recordsTotal": {
      "filteredRecordsTotal": 2,
      "impressions": 248500,
      "clicks": 7455,
      "spent": 4312.75,
      "mediaSpent": 3881.48,
      "dataCost": 216.4,
      "prebidCost": 0,
      "winRate": 26.3,
      "CTR": 3,
      "VCR": 0,
      "workspaceSpent": 3881.48,
      "platformSpent": 431.27,
      "workspaceMediaEarning": 194.07,
      "platformMediaEarning": 388.15,
      "organizationBidShadingSaving": 0,
      "reach": 210000,
      "frequency": 1.18,
      "totalAttributedConversion": 0,
      "ioTotalBudget": 13000
    },
    "recordsList": [
      {
        "ioId": 1001,
        "ioName": "Summer Campaign IO",
        "owId": 200058,
        "organizationName": "Acme Corp",
        "ioBudgetTypeId": 1,
        "ioStatusId": 1,
        "ioStartTime": 1773633600000,
        "ioEndTime": 1775398399000,
        "ioTimezone": 29,
        "isAutoSumIoTotalBudget": true,
        "campaignsCount": 4,
        "ioTotalBudget": 8000,
        "impressions": 148500,
        "clicks": 4455,
        "spent": 2643.8,
        "mediaSpent": 2379.42,
        "winRate": 27.1,
        "CTR": 3,
        "VCR": 0,
        "workspaceSpent": 2379.42,
        "platformSpent": 264.38,
        "totalAttributedConversion": 12,
        "ioPacingPercentage": 33.05
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 50
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000,
    "searchField": "",
    "ioIds": [],
    "campaignBudgetTypeIds": [1, 2],
    "campaignStatusList": ["running", "paused", "pending"]
  },
  "requestType": "AGGREGATED_LIST"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 2,
    "filteredRecords": 2,
    "recordsList": [
      {
        "ioId": 1001,
        "ioName": "Summer Campaign IO",
        "owId": 200058,
        "organizationName": "Acme Corp",
        "ioBudgetTypeId": 1,
        "ioStatusId": 1,
        "ioStartTime": 1773633600000,
        "ioEndTime": 1775398399000,
        "ioTimezone": 29,
        "isAutoSumIoTotalBudget": true,
        "campaignsCount": 4,
        "ioTotalBudget": 8000,
        "impressions": 148500,
        "clicks": 4455,
        "spent": 2643.8,
        "mediaSpent": 2379.42,
        "winRate": 27.1,
        "CTR": 3,
        "VCR": 0,
        "workspaceSpent": 2379.42,
        "platformSpent": 264.38,
        "totalAttributedConversion": 12,
        "ioPacingPercentage": 33.05
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 50
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000
  },
  "requestType": "AGGREGATED_TOTAL"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 0,
    "filteredRecords": 0,
    "recordsTotal": {
      "filteredRecordsTotal": 26,
      "impressions": 248500,
      "clicks": 7455,
      "spent": 4312.75,
      "mediaSpent": 3881.48,
      "dataCost": 216.4,
      "prebidCost": 0,
      "winRate": 26.3,
      "CTR": 3,
      "VCR": 0,
      "workspaceSpent": 3881.48,
      "platformSpent": 431.27,
      "workspaceMediaEarning": 194.07,
      "platformMediaEarning": 388.15,
      "organizationBidShadingSaving": 0,
      "reach": 210000,
      "frequency": 1.18,
      "totalAttributedConversion": 12,
      "ioTotalBudget": 13000,
      "ioTotalImpressions": 500000
    }
  }
}
warning

This version of the API is deprecated. Refer to the v4 endpoint for the latest API functionality.

POST

Get a Report on a Campaign's performance by Insertion Order and supported filters.

Request Schema
startDate
string		Unix epoch timestamp, in milliseconds
endDate
string		Unix epoch timestamp, in milliseconds
timezoneId
integer		Timezone ID
campaignStatus
string		Campaign status
creativeTypeIds
string		Comma separated Creative Type IDs
searchField
string		Filter results by search field
sortBy
string		Sort results by field, default: impressions
order
string		Sorts by ascending (ASC) or descending (DESC)
owIds
string		Comma separated Organization Workspace IDs
pageNo
integer		Page number of retrieved data, default: 1
noOfEntries
integer		Number of entries returned per page, default: 50
resultType
string		Only total data in response (total) or only list of reports in response (data), both if not provided
ioIdsList
array of integers		Insertion Order IDs list
budgetTypeIdList
array of integers		Insertion Order Budget Type ID list
ioStatusIdsList
array of integers		Insertion Order Status ID list
Request Sample
{
  "startDate": "1660834800000",
  "endDate": "1660834800001",
  "timezoneId": 1,
  "campaignStatus": "all",
  "creativeTypeIds": "11,12",
  "searchField": "sample",
  "sortBy": "impressions",
  "order": "DESC",
  "owIds": "1,2,3,4",
  "pageNo": 1,
  "noOfEntries": 50,
  "resultType": "total",
  "ioIdsList": [1, 2, 3],
  "budgetTypeIdList": [1, 2],
  "ioStatusIdsList": [1, 2]
}

Response 200
{    
  "success": true,    
  "data": {        
    "recordsTotal": {            
      "clicks": 0,            
      "totalCount": 26,            
      "winRate": 0,            
      "ioTotalBudget": 98461.95,            
      "impressions": 0,            
      "mediaSpent": 0,            
      "spent": 0,            
      "workspaceSpent": 0,            
      "platformSpent": 0,            
      "CTR": 0,            
      "VCR": 0,            
      "CVR": 0        
    }    
  }
}

Exchange Report​

POST

Get exchange-level aggregated performance report data including impressions, clicks, spend, win rate, and IVT metrics. Supports AGGREGATED, AGGREGATED_LIST, and AGGREGATED_TOTAL request types.

Request Schema
pagination
object		Pagination settings
pagination object properties
pageNo
integer		Page number, default: 1
noOfEntries
integer		Entries per page, default: 200
sort
object		Sorting settings
sort object properties
field
string		Sort by field, default: impressions
order
string		Sort order: ASC or DESC
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
creativeTypeIds
array of integers		Creative Type IDs
campaignIds
array of integers		Campaign IDs
verticalIds
array of integers		Vertical IDs
campaignStatusList
array of strings		Campaign statuses (e.g., running, paused)
requestType
string required		AGGREGATED, AGGREGATED_LIST, or AGGREGATED_TOTAL
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 200
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [1, 2, 3],
    "startTimeEpochMillis": 1773979200000,
    "endTimeEpochMillis": 1774065599000,
    "searchField": "",
    "creativeTypeIds": [],
    "campaignIds": [],
    "verticalIds": [],
    "campaignStatusList": []
  },
  "requestType": "AGGREGATED"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 6,
    "filteredRecords": 6,
    "recordsTotal": {
      "filteredRecordsTotal": 6,
      "impressions": 59960,
      "clicks": 1487,
      "prebidCost": 0,
      "spent": 4514.22,
      "winRate": 251.02,
      "ivtImpressions": 0,
      "ivtClicks": 0,
      "platformSpent": 312.58,
      "workspaceSpent": 3629.59,
      "CTR": 15.35,
      "VCR": 0
    },
    "recordsList": [
      {
        "impressions": 17130,
        "clicks": 392,
        "prebidCost": 0,
        "spent": 1240.22,
        "winRate": 44.53,
        "ivtImpressions": 0,
        "ivtClicks": 0,
        "platformSpent": 79.51,
        "workspaceSpent": 965.18,
        "exchangeId": 16,
        "exchangeName": "Pubmatic",
        "CTR": 2.29,
        "VCR": 0
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 200
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [1, 2, 3],
    "startTimeEpochMillis": 1773979200000,
    "endTimeEpochMillis": 1774065599000,
    "searchField": "",
    "creativeTypeIds": [],
    "campaignIds": [],
    "verticalIds": [],
    "campaignStatusList": []
  },
  "requestType": "AGGREGATED_LIST"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 6,
    "filteredRecords": 6,
    "recordsList": [
      {
        "impressions": 17130,
        "clicks": 392,
        "prebidCost": 0,
        "spent": 1240.22,
        "winRate": 44.53,
        "ivtImpressions": 0,
        "ivtClicks": 0,
        "platformSpent": 79.51,
        "workspaceSpent": 965.18,
        "exchangeId": 16,
        "exchangeName": "Pubmatic",
        "CTR": 2.29,
        "VCR": 0
      },
      {
        "impressions": 15109,
        "clicks": 408,
        "prebidCost": 0,
        "spent": 1143.57,
        "winRate": 40.26,
        "ivtImpressions": 0,
        "ivtClicks": 0,
        "platformSpent": 87.98,
        "workspaceSpent": 927.65,
        "exchangeId": 88,
        "exchangeName": "One Tag",
        "CTR": 2.7,
        "VCR": 0
      }
    ]
  }
}
Request Sample
{
  "filters": {
    "owIds": [1, 2, 3],
    "startTimeEpochMillis": 1773979200000,
    "endTimeEpochMillis": 1774065599000
  },
  "requestType": "AGGREGATED_TOTAL"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 0,
    "filteredRecords": 0,
    "recordsTotal": {
      "filteredRecordsTotal": 6,
      "impressions": 59960,
      "clicks": 1487,
      "prebidCost": 0,
      "spent": 4514.22,
      "winRate": 251.02,
      "ivtImpressions": 0,
      "ivtClicks": 0,
      "platformSpent": 312.58,
      "workspaceSpent": 3629.59,
      "CTR": 15.35,
      "VCR": 0
    }
  }
}
warning

This version of the API is deprecated. Refer to the v4 endpoint for the latest API functionality.

POST

Get a Report on a Campaign's performance by Exchange and supported filters.

Request Schema
startDate
string		Unix epoch timestamp, in milliseconds
endDate
string		Unix epoch timestamp, in milliseconds
timezoneId
integer		Timezone ID
campaignStatus
string		Campaign status
creativeTypeIds
string		Comma separated Creative Type IDs
searchField
string		Filter results by search field
sortBy
string		Sort results by field, default: impressions
order
string		Sorts by ascending (ASC) or descending (DESC)
owIds
string		Comma separated Organization Workspace IDs
pageNo
integer		Page number of retrieved data, default: 1
noOfEntries
integer		Number of entries returned per page, default: 50
resultType
string		Only total data in response (total) or only list of reports in response (data), both if not provided
Request Sample
{
  "startDate": "1660834800000",
  "endDate": "1660834800001",
  "timezoneId": 1,
  "campaignStatus": "all",
  "creativeTypeIds": "",
  "searchField": "",
  "sortBy": "impressions",
  "order": "DESC",
  "owIds": "1,2,3,4",
  "pageNo": 1,
  "noOfEntries": 50,
  "resultType": "total"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 322,
    "filteredRecords": 322,
    "recordsTotal": {
      "clicks": 0,
      "totalCount": 0,
      "winRate": 0,
      "impressions": 0,
      "mediaSpent": 0,
      "spent": 0,
      "workspaceSpent": 0,
      "platformSpent": 0,
      "CTR": 0,
      "VCR": 0,
      "CVR": 0
    }
  }
}

Customer Report​

POST

Get customer (advertiser) level aggregated performance report data including core metrics, spend breakdown, earnings, insights costs, and conversions. Supports AGGREGATED, AGGREGATED_LIST, and AGGREGATED_TOTAL request types.

Request Schema
pagination
object		Pagination settings
pagination object properties
pageNo
integer		Page number, default: 1
noOfEntries
integer		Entries per page, default: 200
sort
object		Sorting settings
sort object properties
field
string		Sort by field, default: impressions
order
string		Sort order: ASC or DESC
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
creativeTypeIds
array of integers		Creative Type IDs
campaignTypeIds
array of integers		Campaign Type IDs
verticalIds
array of integers		Vertical IDs
campaignStatusList
array of strings		Campaign statuses (e.g., running, paused, expired)
requestType
string required		AGGREGATED, AGGREGATED_LIST, or AGGREGATED_TOTAL
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 200
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000,
    "searchField": "",
    "creativeTypeIds": [11, 13, 14, 17],
    "campaignTypeIds": [1],
    "verticalIds": [],
    "campaignStatusList": ["running", "paused", "expired"]
  },
  "requestType": "AGGREGATED"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 4,
    "filteredRecords": 4,
    "recordsTotal": {
      "filteredRecordsTotal": 4,
      "impressions": 105709,
      "clicks": 99,
      "mediaSpent": 1534.25,
      "CTR": 0.094,
      "winRate": 13.52,
      "spent": 1837.82,
      "VCR": 0,
      "dataCost": 18.44,
      "thirdPartyCost": 2.75,
      "workspaceSpent": 623.6,
      "platformSpent": 541.08,
      "workspaceMediaEarning": 512.3,
      "platformMediaEarning": 425.1,
      "organizationBidShadingSaving": 0,
      "totalAttributedConversion": 5,
      "totalAttributedViewThroughConversion": 2,
      "totalAttributedClickThroughConversion": 3,
      "costPerAttributedConversion": 367.56,
      "totalAttributedConversionRate": 0.0047,
      "prebidCost": 0,
      "pldInsightsCost": 12.33,
      "slsInsightsCost": 5.1,
      "vldInsightsCost": 8.75,
      "aqInsightsCost": 3.2,
      "adServingCost": 2.75
    },
    "recordsList": [
      {
        "owId": 200058,
        "organizationName": "Test Organisation - Alpha",
        "budgetDay": 65.69,
        "budgetTotal": 1000,
        "budgetDayCombined": 130.5,
        "budgetTotalCombined": 2000,
        "impressions": 47326,
        "clicks": 42,
        "mediaSpent": 638.47,
        "CTR": 0.0886,
        "winRate": 20.01,
        "spent": 765.72,
        "VCR": 0,
        "dataCost": 8.2,
        "thirdPartyCost": 2.75,
        "workspaceSpent": 253.4,
        "platformSpent": 210.05,
        "workspaceMediaEarning": 210.3,
        "platformMediaEarning": 175.22,
        "organizationBidShadingSaving": 0,
        "totalAttributedConversion": 3,
        "costPerAttributedConversion": 255.24,
        "totalAttributedConversionRate": 0.0063,
        "prebidCost": 0,
        "pldInsightsCost": 6.5,
        "slsInsightsCost": 2.1,
        "vldInsightsCost": 4.25,
        "aqInsightsCost": 1.6,
        "adServingCost": 1.2
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 200
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000,
    "searchField": "",
    "campaignStatusList": []
  },
  "requestType": "AGGREGATED_LIST"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 4,
    "filteredRecords": 4,
    "recordsList": [
      {
        "owId": 200058,
        "organizationName": "Test Organisation - Alpha",
        "budgetDay": 65.69,
        "budgetTotal": 1000,
        "budgetDayCombined": 130.5,
        "budgetTotalCombined": 2000,
        "impressions": 47326,
        "clicks": 42,
        "mediaSpent": 638.47,
        "CTR": 0.0886,
        "winRate": 20.01,
        "spent": 765.72,
        "VCR": 0,
        "dataCost": 8.2,
        "thirdPartyCost": 2.75,
        "workspaceSpent": 253.4,
        "platformSpent": 210.05,
        "workspaceMediaEarning": 210.3,
        "platformMediaEarning": 175.22,
        "organizationBidShadingSaving": 0,
        "totalAttributedConversion": 3,
        "totalAttributedViewThroughConversion": 1,
        "totalAttributedClickThroughConversion": 2,
        "costPerAttributedConversion": 255.24,
        "totalAttributedConversionRate": 0.0063,
        "prebidCost": 0,
        "pldInsightsCost": 6.5,
        "slsInsightsCost": 2.1,
        "vldInsightsCost": 4.25,
        "aqInsightsCost": 1.6,
        "adServingCost": 1.2,
        "platformTotalEarning": 175.22,
        "platformPLDInsightsEarnings": 5.4,
        "platformSLSInsightsEarnings": 1.8,
        "platformVLDInsightsEarnings": 3.6,
        "platformBidShadingEarning": 0,
        "platformAQInsightsEarnings": 1.4,
        "workspaceTotalEarning": 210.3,
        "workspacePLDInsightsEarnings": 1.1,
        "workspaceSLSInsightsEarnings": 0.3,
        "workspaceVLDInsightsEarnings": 0.65,
        "workspaceBidShadingEarning": 0,
        "workspaceAQInsightsEarnings": 0.2
      }
    ]
  }
}
Request Sample
{
  "filters": {
    "owIds": [200058, 200062, 200153, 200178],
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000
  },
  "requestType": "AGGREGATED_TOTAL"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 0,
    "filteredRecords": 0,
    "recordsTotal": {
      "filteredRecordsTotal": 4,
      "impressions": 105709,
      "clicks": 99,
      "mediaSpent": 1534.25,
      "CTR": 0.094,
      "winRate": 13.52,
      "spent": 1837.82,
      "VCR": 0,
      "dataCost": 18.44,
      "thirdPartyCost": 2.75,
      "workspaceSpent": 623.6,
      "platformSpent": 541.08,
      "workspaceMediaEarning": 512.3,
      "platformMediaEarning": 425.1,
      "organizationBidShadingSaving": 0,
      "totalAttributedConversion": 5,
      "totalAttributedViewThroughConversion": 2,
      "totalAttributedClickThroughConversion": 3,
      "costPerAttributedConversion": 367.56,
      "totalAttributedConversionRate": 0.0047,
      "prebidCost": 0,
      "pldInsightsCost": 12.33,
      "slsInsightsCost": 5.1,
      "vldInsightsCost": 8.75,
      "aqInsightsCost": 3.2,
      "adServingCost": 2.75,
      "platformTotalEarning": 425.1,
      "platformPLDInsightsEarnings": 10,
      "platformSLSInsightsEarnings": 4.2,
      "platformVLDInsightsEarnings": 7.5,
      "platformBidShadingEarning": 0,
      "platformAQInsightsEarnings": 2.8,
      "workspaceTotalEarning": 512.3,
      "workspacePLDInsightsEarnings": 2.33,
      "workspaceSLSInsightsEarnings": 0.9,
      "workspaceVLDInsightsEarnings": 1.25,
      "workspaceBidShadingEarning": 0,
      "workspaceAQInsightsEarnings": 0.4
    }
  }
}
warning

This version of the API is deprecated. Refer to the v4 endpoint for the latest API functionality.

POST

Get a Report on a Campaign's performance by Customer(Advertiser) and supported filters.

Request Schema
startDate
string		Unix epoch timestamp, in milliseconds
endDate
string		Unix epoch timestamp, in milliseconds
timezoneId
integer		Timezone ID
campaignStatus
string		Campaign status
creativeTypeIds
string		Comma separated Creative Type IDs
searchField
string		Filter results by search field
sortBy
string		Sort results by field, default: impressions
order
string		Sorts by ascending (ASC) or descending (DESC)
owIds
string		Comma separated Organization Workspace IDs
pageNo
integer		Page number of retrieved data, default: 1
noOfEntries
integer		Number of entries returned per page, default: 50
resultType
string		Only total data in response (total) or only list of reports in response (data), both if not provided
campaignTypeIds
array of integers		Campaign Type IDs list
budgetTypeIdList
array of integers		Budget Type ID list
Request Sample
{
  "startDate": "1660834800000",
  "endDate": "1660834800001",
  "timezoneId": 1,
  "campaignStatus": "all",
  "creativeTypeIds": "",
  "campaignTypeIds": [1],
  "budgetTypeIdList": [1],
  "searchField": "",
  "sortBy": "impressions",
  "order": "DESC",
  "owIds": "1,2,3,4",
  "pageNo": 1,
  "noOfEntries": 50,
  "resultType": "total"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 322,
    "filteredRecords": 322,
    "recordsTotal": {
      "clicks": 0,
      "totalCount": 322,
      "winRate": 0,
      "impressions": 0,
      "mediaSpent": 0,
      "spent": 0,
      "workspaceSpent": 0,
      "platformSpent": 0,
      "CTR": 0,
      "VCR": 0,
      "CVR": 0
    }
  }
}

Campaign Report​

POST

Get campaign-level aggregated performance report data including core metrics, pacing, budget, reach/frequency, insights costs, earnings, and conversions. Supports AGGREGATED, AGGREGATED_LIST, and AGGREGATED_TOTAL request types.

Request Schema
pagination
object		Pagination settings
pagination object properties
pageNo
integer		Page number, default: 1
noOfEntries
integer		Entries per page, default: 50
sort
object		Sorting settings
sort object properties
field
string		Sort by field, default: impressions
order
string		Sort order: ASC or DESC
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
campaignTypeIds
array of integers		Campaign Type IDs
campaignBudgetTypeIds
array of integers		Budget Type IDs
creativeTypeIds
array of integers		Creative Type IDs
ioIds
array of integers		Insertion Order IDs
campaignIds
array of integers		Campaign IDs
verticalIds
array of integers		Vertical IDs
campaignStatusList
array of strings		Campaign statuses (e.g., pending, running)
requestType
string required		AGGREGATED, AGGREGATED_LIST, or AGGREGATED_TOTAL
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 50
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [1, 2, 3, 4],
    "startTimeEpochMillis": 1660834800000,
    "endTimeEpochMillis": 1660834800001,
    "searchField": "",
    "campaignTypeIds": [1],
    "campaignBudgetTypeIds": [1, 2],
    "campaignStatusList": ["pending", "running"],
    "creativeTypeIds": [1, 2],
    "ioIds": [1, 2, 3],
    "campaignIds": [1, 2, 3],
    "verticalIds": [1, 2]
  },
  "requestType": "AGGREGATED"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 200,
    "filteredRecords": 200,
    "recordsTotal": {
      "impressions": 0,
      "bidImpressions": 285,
      "clicks": 0,
      "reach": null,
      "dataCost": 0,
      "prebidCost": 0,
      "spent": 0,
      "mediaSpent": 0,
      "budgetDay": 2185975387.14,
      "budgetTotal": 125574558558992,
      "winRate": 0,
      "totalECPC": 0,
      "frequency": null,
      "totalECPM": 0,
      "ivtImpressions": 0,
      "ivtClicks": 0,
      "adServingCost": 0,
      "vldInsightsCost": 583.164,
      "pldInsightsCost": 0,
      "slsInsightsCost": 0,
      "aqInsightsCost": 0,
      "totalAttributedConversion": 0,
      "organizationBidShadingSaving": 0,
      "platformSpent": 0,
      "platformMediaEarning": 0,
      "workspaceSpent": 0,
      "workspaceMediaEarning": 0,
      "CTR": 0,
      "VCR": 0
    },
    "recordsList": [
      {
        "impressions": 0,
        "bidImpressions": 0,
        "clicks": 0,
        "reach": 0,
        "dataCost": 0,
        "prebidCost": 0,
        "spent": 0,
        "mediaSpent": 0,
        "budgetDay": 0,
        "budgetTotal": 1020,
        "winRate": 0,
        "totalECPC": 0,
        "frequency": 0,
        "totalECPM": 0,
        "ivtImpressions": 0,
        "ivtClicks": 0,
        "adServingCost": 0,
        "vldInsightsCost": 0,
        "pldInsightsCost": 0,
        "slsInsightsCost": 0,
        "aqInsightsCost": 0,
        "totalAttributedConversion": 0,
        "organizationBidShadingSaving": 0,
        "platformSpent": null,
        "platformMediaEarning": null,
        "workspaceSpent": null,
        "workspaceMediaEarning": null,
        "campaignId": 582315,
        "campaignName": "P n",
        "startTime": 1773214800,
        "endTime": 0,
        "campaignType": "cpm",
        "status": "pending",
        "dailyImpression": 0,
        "campaignTimezone": "US/Eastern",
        "creativeType": "13",
        "budgetPacing": false,
        "owId": 201427,
        "bidShading": false,
        "ioId": 10374,
        "ioName": "DD",
        "ioStartTime": 1715054400000,
        "ioEndTime": 0,
        "ioTotalBudget": 386836.845,
        "ioTimezone": 29,
        "ioStatusId": 1,
        "organizationName": "Stage Shared Advertiser",
        "percentageOfTotalSpent": 0,
        "maxBid": 55,
        "baseBid": 0,
        "budgetTypeId": 1,
        "campaignTypeId": 2,
        "targetImpression": 0,
        "budgetDayCombined": 0,
        "budgetTotalCombined": 1020,
        "expectedSpent": 0,
        "actualSpent": 0,
        "pacingPercentage": 0,
        "remainingDuration": 0,
        "campaignDuration": 0,
        "creativesCount": 2,
        "aiGoalId": 0,
        "CTR": 0,
        "VCR": 0
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 50
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [1, 2, 3, 4],
    "startTimeEpochMillis": 1660834800000,
    "endTimeEpochMillis": 1660834800001,
    "searchField": "",
    "campaignTypeIds": [1],
    "campaignBudgetTypeIds": [1, 2],
    "campaignStatusList": ["pending", "running"],
    "creativeTypeIds": [1, 2],
    "ioIds": [1, 2, 3],
    "campaignIds": [1, 2, 3],
    "verticalIds": [1, 2]
  },
  "requestType": "AGGREGATED_LIST"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 200,
    "filteredRecords": 200,
    "recordsList": [
      {
        "impressions": 0,
        "bidImpressions": 0,
        "clicks": 0,
        "reach": 0,
        "dataCost": 0,
        "prebidCost": 0,
        "spent": 0,
        "mediaSpent": 0,
        "budgetDay": 0,
        "budgetTotal": 1020,
        "winRate": 0,
        "totalECPC": 0,
        "frequency": 0,
        "totalECPM": 0,
        "ivtImpressions": 0,
        "ivtClicks": 0,
        "adServingCost": 0,
        "vldInsightsCost": 0,
        "pldInsightsCost": 0,
        "slsInsightsCost": 0,
        "aqInsightsCost": 0,
        "totalAttributedConversion": 0,
        "organizationBidShadingSaving": 0,
        "platformSpent": null,
        "platformMediaEarning": null,
        "workspaceSpent": null,
        "workspaceMediaEarning": null,
        "campaignId": 582315,
        "campaignName": "P n",
        "startTime": 1773214800,
        "endTime": 0,
        "campaignType": "cpm",
        "status": "pending",
        "dailyImpression": 0,
        "campaignTimezone": "US/Eastern",
        "creativeType": "13",
        "budgetPacing": false,
        "owId": 201427,
        "bidShading": false,
        "ioId": 10374,
        "ioName": "DD",
        "ioStartTime": 1715054400000,
        "ioEndTime": 0,
        "ioTotalBudget": 386836.845,
        "ioTimezone": 29,
        "ioStatusId": 1,
        "organizationName": "Stage Shared Advertiser",
        "percentageOfTotalSpent": 0,
        "maxBid": 55,
        "baseBid": 0,
        "budgetTypeId": 1,
        "campaignTypeId": 2,
        "targetImpression": 0,
        "budgetDayCombined": 0,
        "budgetTotalCombined": 1020,
        "expectedSpent": 0,
        "actualSpent": 0,
        "pacingPercentage": 0,
        "remainingDuration": 0,
        "campaignDuration": 0,
        "creativesCount": 2,
        "aiGoalId": 0,
        "CTR": 0,
        "VCR": 0
      }
    ]
  }
}
Request Sample
{
  "pagination": {
    "pageNo": 1,
    "noOfEntries": 50
  },
  "sort": {
    "field": "impressions",
    "order": "DESC"
  },
  "filters": {
    "owIds": [1, 2, 3, 4],
    "startTimeEpochMillis": 1660834800000,
    "endTimeEpochMillis": 1660834800001
  },
  "requestType": "AGGREGATED_TOTAL"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 0,
    "filteredRecords": 0,
    "recordsTotal": {
      "impressions": 0,
      "bidImpressions": 285,
      "clicks": 0,
      "reach": null,
      "dataCost": 0,
      "prebidCost": 0,
      "spent": 0,
      "mediaSpent": 0,
      "budgetDay": 2185975387.14,
      "budgetTotal": 125574558558992,
      "winRate": 0,
      "totalECPC": 0,
      "frequency": null,
      "totalECPM": 0,
      "ivtImpressions": 0,
      "ivtClicks": 0,
      "adServingCost": 0,
      "vldInsightsCost": 583.164,
      "pldInsightsCost": 0,
      "slsInsightsCost": 0,
      "aqInsightsCost": 0,
      "totalAttributedConversion": 0,
      "organizationBidShadingSaving": 0,
      "platformSpent": 0,
      "platformMediaEarning": 0,
      "workspaceSpent": 0,
      "workspaceMediaEarning": 0,
      "CTR": 0,
      "VCR": 0
    }
  }
}
warning

This version of the API is deprecated. Refer to the v4 endpoint for the latest API functionality.

POST

Get a Report on a Campaign's performance by supported filters.

Request Schema
startDate
string		Unix epoch timestamp, in milliseconds
endDate
string		Unix epoch timestamp, in milliseconds
timezoneId
integer		Timezone ID
campaignStatus
string		Campaign status
creativeTypeIds
string		Comma separated Creative Type IDs
searchField
string		Filter results by search field
sortBy
string		Sort results by field, default: impressions
order
string		Sorts by ascending (ASC) or descending (DESC)
owIds
string		Comma separated Organization Workspace IDs
pageNo
integer		Page number of retrieved data, default: 1
noOfEntries
integer		Number of entries returned per page, default: 50
resultType
string		Only total data in response (total) or only list of reports in response (data), both if not provided
ioIdsList
array of integers		Insertion Order IDs list
campaignTypeIds
array of integers		Campaign Type IDs list
CampaignIds
array of integers		Campaign IDs list
Request Sample
{
  "startDate": "1660834800000",
  "endDate": "1660834800001",
  "timezoneId": 1,
  "campaignStatus": "all",
  "creativeTypeIds": "",
  "searchField": "",
  "sortBy": "impressions",
  "order": "DESC",
  "owIds": "1,2,3,4",
  "pageNo": 1,
  "noOfEntries": 50,
  "resultType": "total",
  "ioIdsList": [1, 2, 3],
  "campaignTypeIds": [1],
  "campaignIds": "1,2,3"
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 1,
    "filteredRecords": 1,
    "recordsTotal": {
      "clicks": 0,
      "totalCount": 1,
      "winRate": 0,
      "impressions": 0,
      "mediaSpent": 0,
      "spent": 0,
      "workspaceSpent": 0,
      "platformSpent": 0,
      "CTR": 0,
      "VCR": 0,
      "CVR": 0
    }
  }
}

Metrics Timeline​

POST

Get time-bucketed performance data points for graphing metrics over a date range. Returns an array of data points, each representing a time interval with aggregated metrics such as impressions, clicks, spend, win rate, and video completion rates.

Request Schema
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
campaignTypeIds
array of integers		Campaign Type IDs
campaignBudgetTypeIds
array of integers		Budget Type IDs
creativeTypeIds
array of integers		Creative Type IDs
ioIds
array of integers		Insertion Order IDs
campaignIds
array of integers		Campaign IDs
verticalIds
array of integers		Vertical IDs
campaignStatusList
array of strings		Campaign statuses (e.g., running, paused)
dimension
string required		Grouping dimension, e.g., CAMPAIGN
timezoneId
integer		Timezone ID
Response Properties
totalRecords
integer		Total number of time-bucket records
recordsList
array of objects		Array of time-bucket data points
recordsList object properties
startDate
integer		Bucket start time, unix epoch in milliseconds
endDate
integer		Bucket end time, unix epoch in milliseconds
impressions
integer		Number of impressions
clicks
integer		Number of clicks
spent
number		Total spend
mediaSpent
number		Media spend
winRate
number		Win rate percentage
CTR
number		Click-through rate
eCPM
number		Effective cost per mille
totalECPM
number		Total effective cost per mille
eCPC
number		Effective cost per click
totalECPC
number		Total effective cost per click
eCPCV
number		Effective cost per completed view
VCR
number		Video completion rate
totalAttributedConversion
integer		Total attributed conversions
Request Sample
{
  "filters": {
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1773719999000
  },
  "dimension": "CAMPAIGN",
  "timezoneId": 29
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 24,
    "recordsList": [
      {
        "startDate": 1773633600000,
        "endDate": 1773636599000,
        "impressions": 21000,
        "clicks": 630,
        "spent": 2100,
        "mediaSpent": 1890,
        "startCount": 0,
        "firstCount": 0,
        "midCount": 0,
        "thirdCount": 0,
        "completeCount": 0,
        "winRate": 28.5,
        "CTR": 3,
        "eCPM": 90,
        "totalECPM": 100,
        "eCPC": 3,
        "totalECPC": 3.5,
        "eCPCV": 0,
        "VCR": 0,
        "totalAttributedConversion": 0,
        "workspaceSpent": 1750,
        "platformSpent": 210,
        "platformMediaEarning": 189,
        "workspaceMediaEarning": 945
      }
    ]
  }
}
Request Sample
{
  "filters": {
    "startTimeEpochMillis": 1771041600000,
    "endTimeEpochMillis": 1773719999000,
    "campaignStatusList": ["running", "paused"],
    "owIds": [200058, 200062],
    "campaignIds": [582510, 582511]
  },
  "dimension": "CAMPAIGN",
  "timezoneId": 29
}

Response 200
{
  "success": true,
  "data": {
    "totalRecords": 24,
    "recordsList": [
      {
        "startDate": 1773633600000,
        "endDate": 1773636599000,
        "impressions": 21000,
        "clicks": 630,
        "spent": 2100,
        "mediaSpent": 1890,
        "startCount": 0,
        "firstCount": 0,
        "midCount": 0,
        "thirdCount": 0,
        "completeCount": 0,
        "winRate": 28.5,
        "CTR": 3,
        "eCPM": 90,
        "totalECPM": 100,
        "eCPC": 3,
        "totalECPC": 3.5,
        "eCPCV": 0,
        "VCR": 0,
        "totalAttributedConversion": 0,
        "workspaceSpent": 1750,
        "platformSpent": 210,
        "platformMediaEarning": 189,
        "workspaceMediaEarning": 945
      }
    ]
  }
}

Metrics Comparison​

POST

Compare aggregated performance metrics between the current and previous time periods. Returns side-by-side current and previous period objects with key metrics for evaluating performance trends.

Request Schema
filters
object required		Filter criteria
filters object properties
owIds
array of integers		Organization Workspace IDs
startTimeEpochMillis
integer required		Start time, unix epoch in milliseconds
endTimeEpochMillis
integer required		End time, unix epoch in milliseconds
searchField
string		Search filter
campaignTypeIds
array of integers		Campaign Type IDs
campaignBudgetTypeIds
array of integers		Budget Type IDs
creativeTypeIds
array of integers		Creative Type IDs
ioIds
array of integers		Insertion Order IDs
campaignIds
array of integers		Campaign IDs
verticalIds
array of integers		Vertical IDs
campaignStatusList
array of strings		Campaign statuses (e.g., running)
dimension
string required		Grouping dimension, e.g., CAMPAIGN
Response Properties
current
object		Metrics for the requested time period
previous
object		Metrics for the equivalent preceding time period
current / previous object properties
impressions
integer		Number of impressions
clicks
integer		Number of clicks
spent
number		Total spend
mediaSpent
number		Media spend
CTR
number		Click-through rate
totalECPC
number		Total effective cost per click
totalECPM
number		Total effective cost per mille
winRate
number		Win rate percentage
Request Sample
{
  "filters": {
    "startTimeEpochMillis": 1773719999000,
    "endTimeEpochMillis": 1773806399000,
    "campaignIds": [582510]
  },
  "dimension": "CAMPAIGN"
}

Response 200
{
  "success": true,
  "data": {
    "current": {
      "impressions": 500000,
      "clicks": 15000,
      "spent": 50000,
      "CTR": 3,
      "totalECPC": 3.33,
      "totalECPM": 100,
      "winRate": 285,
      "mediaSpent": 45000
    },
    "previous": {
      "impressions": 480000,
      "clicks": 14400,
      "spent": 48000,
      "CTR": 3,
      "totalECPC": 3.33,
      "totalECPM": 100,
      "winRate": 280,
      "mediaSpent": 43200
    }
  }
}
Request Sample
{
  "filters": {
    "startTimeEpochMillis": 1773633600000,
    "endTimeEpochMillis": 1774238399000,
    "searchField": "temp-camp",
    "creativeTypeIds": [11, 13, 14, 17],
    "campaignTypeIds": [1],
    "campaignIds": [582510, 582511, 582512],
    "campaignStatusList": ["running"],
    "owIds": [200058, 200062, 200153, 200178],
    "ioIds": [],
    "verticalIds": []
  },
  "dimension": "CAMPAIGN"
}

Response 200
{
  "success": true,
  "data": {
    "current": {
      "impressions": 500000,
      "clicks": 15000,
      "spent": 50000,
      "CTR": 3,
      "totalECPC": 3.33,
      "totalECPM": 100,
      "winRate": 285,
      "mediaSpent": 45000
    },
    "previous": {
      "impressions": 480000,
      "clicks": 14400,
      "spent": 48000,
      "CTR": 3,
      "totalECPC": 3.33,
      "totalECPM": 100,
      "winRate": 280,
      "mediaSpent": 43200
    }
  }
}
Have a question?
Ask the Community
Was this page helpful?