#%RAML 0.8 title: "Dashboard Query Service" version: "andorian-1.0.0-SNAPSHOT:DEVELOPER_BUILD" baseUri: "https://localhost:8443" protocols: [HTTPS] mediaType: "application/json" "/query": "/frequency-uniques-household": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "frequencyBands", "frequencyBuckets", "frequencyTarget"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "clientId" : { "type" : "integer", "required" : true }, "advertiserId" : { "type" : "integer", "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "kpi" : { "type" : "string", "required" : true }, "levelType" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "uniques" : { "type" : "integer" }, "cost" : { "type" : "number" }, "currencyCode" : { "type" : "string" } } }, "frequencyBands" : { "type" : "array" }, "frequencyBuckets" : { "type" : "array" }, "frequencyTarget" : { "type" : "object", "properties" : { "bucketNumber" : { "type" : "integer" }, "bucketStart" : { "type" : "integer" }, "bucketEnd" : { "type" : "integer" } } } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/conversion-type-details": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["reportHeader", "conversionTypeMetrics"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "reportHeader" : { "type" : "object", "properties" : { "advertiser" : { "type" : "string" }, "campaignOrCampaignGroup" : { "type" : "string" }, "dateRange" : { "type" : "string" }, "dimension" : { "type" : "string" } } }, "conversionTypeMetrics" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/trends-actions-filter": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "conversionTypes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "tagId" : { "type" : "integer" }, "conversionType" : { "type" : "string" } } }, "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } }, "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "conversionTypePairs" : { "type" : "array", "items" : { "type" : "string" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "metricsByDate" : { "type" : "array", "items" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "value" : { "type" : "object", "properties" : { "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" } } } } } } } }, "metricsByEntity" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-to-kpi": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "frequencyBands", "frequencyBuckets", "frequencyTarget"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "clientId" : { "type" : "integer", "required" : true }, "advertiserId" : { "type" : "integer", "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "impressionLookback" : { "type" : "integer", "required" : true }, "kpi" : { "type" : "string", "required" : true }, "levelType" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "uniques" : { "type" : "integer" }, "cost" : { "type" : "number" }, "postKpiImpressions" : { "type" : "integer" }, "postKpiCost" : { "type" : "number" }, "currencyCode" : { "type" : "string" } } }, "frequencyBands" : { "type" : "array" }, "frequencyBuckets" : { "type" : "array" }, "frequencyTarget" : { "type" : "object", "properties" : { "bucketNumber" : { "type" : "integer" }, "bucketStart" : { "type" : "integer" }, "bucketEnd" : { "type" : "integer" } } } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/trends": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" }, "metricsByDate" : { "type" : "array", "items" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "value" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" }, "cumulativeUniques" : { "type" : "integer" } } } } } } } }, "metricsByEntity" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/inventory-provider-core-with-overlap": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "limitResult" : { "type" : "integer" }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "metricsByEntity" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/reach-and-overlap-actions-filter": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "reachAndOverlapSummary", "entityReachAndOverlapMetrics"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ] }, "conversionTypes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "tagId" : { "type" : "integer" }, "conversionType" : { "type" : "string" } } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } }, "conversionTypePairs" : { "type" : "array", "items" : { "type" : "string" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "reachAndOverlapSummary" : { "type" : "object", "properties" : { "actionTotalUniques" : { "type" : "integer" } } }, "entityReachAndOverlapMetrics" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-uniques-by-inventory-provider": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["frequencyByInventoryProvider"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "kpi" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "frequencyByInventoryProvider" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/cross-device-core": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "metricsByInfoLevel", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "metricsByInfoLevel" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/geography-core-country": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "metricsByContinent", "metricsByCountry"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "countryCodeId" : { "type" : "string", "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "metricsByContinent" : { "type" : "array" }, "metricsByCountry" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/reach-and-overlap-exact-count": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "reachAndOverlapSummary", "entityReachAndOverlapMetrics"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ] }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "dimensionTypeString" : { "type" : "string" }, "scopeType" : { "type" : "string" } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "reachAndOverlapSummary" : { "type" : "object", "properties" : { "impressionTotalUniques" : { "type" : "integer" }, "clickTotalUniques" : { "type" : "integer" }, "actionTotalUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "entityReachAndOverlapMetrics" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/reach-and-overlap-audience-filter": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "reachAndOverlapSummary", "availablePlatforms", "entityReachAndOverlapMetrics"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ] }, "audienceIds" : { "type" : "array", "items" : { "type" : "integer" }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "reachAndOverlapSummary" : { "type" : "object", "properties" : { "impressionTotalUniques" : { "type" : "integer" }, "clickTotalUniques" : { "type" : "integer" }, "actionTotalUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "availablePlatforms" : { "type" : "array" }, "entityReachAndOverlapMetrics" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/inventory-provider-audience-filter": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "audienceIds" : { "type" : "array", "items" : { "type" : "integer" }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "metricsByEntity" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/inventory-provider-audience-filter-with-overlap": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "audienceIds" : { "type" : "array", "items" : { "type" : "integer" }, "required" : true }, "limitResult" : { "type" : "integer" }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "metricsByEntity" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/overall-metrics-by-platform": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" }, "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" }, "metricsByDate" : { "type" : "array", "items" : { "type" : "object", "properties" : { "date" : { "type" : "string" }, "value" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" }, "cumulativeUniques" : { "type" : "integer" } } } } } } } } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/intraday-core": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "metricsByHour"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" } } }, "metricsByHour" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-uniques": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "frequencyBands", "frequencyBuckets", "frequencyTarget"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "clientId" : { "type" : "integer", "required" : true }, "advertiserId" : { "type" : "integer", "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "kpi" : { "type" : "string", "required" : true }, "levelType" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "uniques" : { "type" : "integer" }, "cost" : { "type" : "number" }, "currencyCode" : { "type" : "string" } } }, "frequencyBands" : { "type" : "array" }, "frequencyBuckets" : { "type" : "array" }, "frequencyTarget" : { "type" : "object", "properties" : { "bucketNumber" : { "type" : "integer" }, "bucketStart" : { "type" : "integer" }, "bucketEnd" : { "type" : "integer" } } } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/latest-precalc-date": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["latestPrecalcDate"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "fakeInput" : { "type" : "string" } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "latestPrecalcDate" : { "type" : "object", "properties" : { "date" : { "type" : "string" } } } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/inventory-provider-audience-report": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["metricsByEntity"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "metricsByEntity" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-to-kpi-household": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "frequencyBands", "frequencyBuckets", "frequencyTarget"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "clientId" : { "type" : "integer", "required" : true }, "advertiserId" : { "type" : "integer", "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "impressionLookback" : { "type" : "integer", "required" : true }, "kpi" : { "type" : "string", "required" : true }, "levelType" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "uniques" : { "type" : "integer" }, "cost" : { "type" : "number" }, "postKpiImpressions" : { "type" : "integer" }, "postKpiCost" : { "type" : "number" }, "currencyCode" : { "type" : "string" } } }, "frequencyBands" : { "type" : "array" }, "frequencyBuckets" : { "type" : "array" }, "frequencyTarget" : { "type" : "object", "properties" : { "bucketNumber" : { "type" : "integer" }, "bucketStart" : { "type" : "integer" }, "bucketEnd" : { "type" : "integer" } } } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/attribute-monitoring-report": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["uniqueCollectionAttributes"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "providerIds" : { "type" : "array", "items" : { "type" : "integer" }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "uniqueCollectionAttributes" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/dayparting-core": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["overallMetrics", "metricsByHour", "metricsByWeekday", "metricsByHourByWeekday", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" } } }, "metricsByHour" : { "type" : "array" }, "metricsByWeekday" : { "type" : "array" }, "metricsByHourByWeekday" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-to-kpi-by-inventory-provider-household": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["frequencyByInventoryProvider"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "impressionLookback" : { "type" : "integer", "required" : true }, "kpi" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "frequencyByInventoryProvider" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/inventory-provider-core": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "metricsByEntity" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/inventory-provider-actions-filter": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByEntity"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "conversionTypes" : { "type" : "array", "items" : { "type" : "object", "properties" : { "tagId" : { "type" : "integer" }, "conversionType" : { "type" : "string" } } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } }, "conversionTypePairs" : { "type" : "array", "items" : { "type" : "string" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "actions" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" } } }, "metricsByEntity" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-to-kpi-by-inventory-provider": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["frequencyByInventoryProvider"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "impressionLookback" : { "type" : "integer", "required" : true }, "kpi" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "frequencyByInventoryProvider" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/geography-core-continent": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "overallMetrics", "metricsByContinent", "metricsByCountry"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ], "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "overallMetrics" : { "type" : "object", "properties" : { "impressions" : { "type" : "integer" }, "clicks" : { "type" : "integer" }, "actions" : { "type" : "integer" }, "impressionUniques" : { "type" : "integer" }, "clickUniques" : { "type" : "integer" }, "actionUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "metricsByContinent" : { "type" : "array" }, "metricsByCountry" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/frequency-uniques-by-inventory-provider-household": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["frequencyByInventoryProvider"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "kpi" : { "type" : "string", "required" : true } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "frequencyByInventoryProvider" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/reach-and-overlap-exact-count-household": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "reachAndOverlapSummary", "entityReachAndOverlapMetrics"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ] }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "dimensionTypeString" : { "type" : "string" }, "scopeType" : { "type" : "string" } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "reachAndOverlapSummary" : { "type" : "object", "properties" : { "impressionTotalUniques" : { "type" : "integer" }, "clickTotalUniques" : { "type" : "integer" }, "actionTotalUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "entityReachAndOverlapMetrics" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "/reach-and-overlap": post: queryParameters: "reportPart": type: string required: false repeat: true enum: ["dateRange", "reachAndOverlapSummary", "entityReachAndOverlapMetrics", "availablePlatforms"] "mock": type: boolean required: false repeat: false default: "false" body: "application/json": schema: | { "type" : "object", "properties" : { "dimensionType" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ], "required" : true }, "entities" : { "type" : "object", "properties" : { "ids" : { "type" : "array", "items" : { "type" : "integer" } }, "type" : { "type" : "string", "enum" : [ "Audience", "Campaign", "CampaignGroup", "Provider", "Taxonomy", "TaxonomyEntry", "Namespace", "Site", "Client" ] } }, "required" : true }, "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } }, "required" : true }, "granularity" : { "type" : "string", "enum" : [ "DAILY", "WEEKLY", "MONTHLY", "QUARTERLY", "CAMPAIGN_LIFETIME" ] }, "dateRangeEnum" : { "type" : "string", "enum" : [ "YESTERDAY", "LAST_7_DAYS", "LAST_30_DAYS", "LAST_90_DAYS", "CAMPAIGN_LIFETIME", "CUSTOM_DATES", "CUSTOM_MONTHS", "CURRENT_MONTH_TO_DATE", "_1_MONTH_LAG", "_2_MONTH_LAG", "_3_MONTH_LAG", "_4_MONTH_LAG", "_5_MONTH_LAG", "_6_MONTH_LAG", "_7_MONTH_LAG", "_8_MONTH_LAG", "_9_MONTH_LAG", "_10_MONTH_LAG", "_11_MONTH_LAG", "_12_MONTH_LAG", "_13_MONTH_LAG", "_14_MONTH_LAG", "_15_MONTH_LAG", "_1_QUARTER_LAG", "_2_QUARTER_LAG", "_3_QUARTER_LAG", "_4_QUARTER_LAG", "_5_QUARTER_LAG", "LAST_3_MONTHS", "LAST_YEAR" ], "required" : true }, "platformIds" : { "type" : "array", "items" : { "type" : "integer" } } } } responses: "201": body: "application/json": schema: | { "type" : "object", "properties" : { "dateRange" : { "type" : "object", "properties" : { "from" : { "type" : "string" }, "to" : { "type" : "string" } } }, "reachAndOverlapSummary" : { "type" : "object", "properties" : { "impressionTotalUniques" : { "type" : "integer" }, "clickTotalUniques" : { "type" : "integer" }, "actionTotalUniques" : { "type" : "integer" }, "profitAndLoss" : { "type" : "array" } } }, "entityReachAndOverlapMetrics" : { "type" : "array" }, "availablePlatforms" : { "type" : "array" } } } "400": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "404": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } } "422": body: "application/json": schema: | { "type" : "object", "properties" : { "errors" : { "type" : "array" } } }