{ "openapi" : "3.0.1", "info" : { "title" : "Cuebiq API", "description" : "Create and manage Campaigns and Geoset via Cuebiq external APIs", "version" : "0.1.0" }, "tags" : [ { "name" : "geoset", "description" : "The endpoints managing geosets" }, { "name" : "Conversion Feed V1" }, { "name" : "KPIs V2 - Campaign Reports" }, { "name" : "KPIs V2 - Campaigns" }, { "name" : "KPIs V2 - Customer" }, { "name" : "KPIs V2 - Shared Campaign Reports" }, { "name" : "KPIs V2 - Shared Campaigns" }, { "name" : "KPIs V2 - Shared Reports" }, { "name" : "Measurement V2" } ], "servers" : [ { "url" : "https://...", "description" : "Cuebiq API gateway" } ], "security" : [ { "cuebiq_auth" : [ ] } ], "paths" : { "/v1/customers/{customerId}/conversion-feeds" : { "get" : { "summary" : "All conversion feeds", "description" : "Get the list of all conversion feeds for a customer", "operationId" : "getConversionFeeds", "tags" : [ "Conversion Feed V1" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "page", "in" : "query", "schema" : { "format" : "int32", "default" : 0, "type" : "integer" } }, { "name" : "size", "in" : "query", "schema" : { "format" : "int32", "default" : 20, "type" : "integer" } }, { "name" : "sort", "in" : "query", "schema" : { "type" : "string", "nullable" : true } }, { "name" : "status", "in" : "query", "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConversionFeedStatus" }, "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetConversionFeedsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Conversion Feed not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v1/customers/{customerId}/geosets" : { "post" : { "summary" : "Insert a new Geoset with brand information from a file.", "description" : "Insert a new Geoset with brand information from a file.", "operationId" : "postGeosets", "tags" : [ "geoset" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PostGeosetRequestBodyRaw" } } }, "required" : true }, "responses" : { "201" : { "description" : "The id of geoset created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PostGeosetResponse" } } } }, "401" : { "description" : "Not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "get" : { "summary" : "Get the list of geosets", "description" : "Get the list of geosets optionally filtered by external_ref or geoset name", "operationId" : "getGeosets", "tags" : [ "geoset" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "externalRef", "in" : "query", "schema" : { "type" : "string", "nullable" : true } }, { "name" : "name", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "The list of geosets", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetGeosetsResponse" } } } }, "401" : { "description" : "Not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v1/customers/{customerId}/geosets/upload-urls" : { "post" : { "summary" : "Create Pre-signed S3 URL", "description" : "Generate and returns a new pre-signed URL to perform a file upload on S3.", "operationId" : "postGeosetsUploadUrls", "tags" : [ "geoset" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "201" : { "description" : "The presigned urls path created", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GeosetS3PreSignedUrlResponse" } } } }, "401" : { "description" : "Not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v1/customers/{customerId}/geosets/{geosetId}" : { "get" : { "summary" : "Get the geoset by id", "description" : "Get the geoset definition by its id", "operationId" : "getGeoset", "tags" : [ "geoset" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "geosetId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "The geoset", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Geoset" } } } }, "401" : { "description" : "Not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v1/customers/{customerId}/geosets/{geosetId}/places" : { "get" : { "summary" : "Get the geoset by id places", "description" : "Get the geoset places by geoset id, this call is paginated, look at nextId field, if null no more items are returned in subsequent calls.", "operationId" : "getGeosetsPlaces", "tags" : [ "geoset" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "geosetId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "fromId", "in" : "query", "schema" : { "format" : "int64", "minimum" : 0, "type" : "integer", "nullable" : true } }, { "name" : "limit", "in" : "query", "schema" : { "format" : "int32", "minimum" : 0, "exclusiveMinimum" : true, "type" : "integer", "nullable" : true } }, { "name" : "sortOrder", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "The geoset places paginated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetPlacesResponse" } } } }, "401" : { "description" : "Not authenticated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns" : { "get" : { "summary" : "All campaigns", "description" : "Get the list of all campaigns optionally filtered by external_ref", "operationId" : "getCampaigns", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "externalRef", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetCampaignsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "post" : { "summary" : "Creates a campaign", "description" : "Creates a campaign optionally setting and external reference. We highly recommend setting brandId = 1983 for smoother setup operations.", "operationId" : "createCampaign", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCampaignRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/kpis/performance" : { "get" : { "summary" : "Performance KPIs Snapshot", "description" : "Get a snapshot of all performance kpis at a given date.", "operationId" : "getCampaignsPerformanceKpis", "tags" : [ "KPIs V2 - Customer" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "date", "in" : "query", "schema" : { "type" : "string", "nullable" : true } }, { "name" : "ownership", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CampaignPerformanceKpis" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}" : { "get" : { "summary" : "A campaign", "description" : "Get information about a campaign.", "operationId" : "getCampaign", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "summary" : "Delete a campaign", "description" : "Delete a campaign by campaign id", "operationId" : "deleteCampaign", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "204" : { "description" : "Request succeeded" }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/geoset" : { "put" : { "summary" : "Update the geoset of a campaign", "description" : "Update the geoset of a campaign by providing geoset id and geoset filters such as dmas and states.", "operationId" : "updateCampaignGeoset", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "description" : "*geosetFilter* is optional, but if set only one of *dmas* or *states* must be specified", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/UpdateCampaignGeosetRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/impressions" : { "get" : { "summary" : "Impressions", "description" : "A total count of impressions served.", "operationId" : "getCampaignImpression", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Impressions" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/incremental-visits" : { "get" : { "summary" : "Incremental Projected Visits", "description" : "The number of projected visits that can be attributed to campaign exposure.", "operationId" : "getCampaignIncrementalVisits", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IncrementalVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/measured-people" : { "get" : { "summary" : "Measured People", "description" : "Reached people who are also in Cuebiq’s universe of devices.", "operationId" : "getCampaignMeasuredPeople", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/measured-visits" : { "get" : { "summary" : "Measured Visits", "description" : "The total number of visits made by measured people within the conversion window.", "operationId" : "getCampaignMeasuredVisits", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/performance" : { "get" : { "summary" : "Performance KPIs Snapshot", "description" : "Get a snapshot of all performance kpis at a given date.", "operationId" : "getCampaignPerformanceKpis", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "date", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PerformanceKpis" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/projected-visits" : { "get" : { "summary" : "Projected Visits", "description" : "An estimate of how many visits we would have seen if all reached people were in Cuebiq’s panel. \n In other words, measured visits projected to align with the estimated number of reached people.", "operationId" : "getCampaignProjectedVisits", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectedVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/rankings" : { "get" : { "summary" : "Performance Rankings", "description" : "Get performance rankings on reports grouped by KPIs.", "operationId" : "getCampaignRankings", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PerformanceRankingResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/reached-people" : { "get" : { "summary" : "Reached People", "description" : "An estimate of people exposed to an impression in the campaign", "operationId" : "getCampaignReachedPeople", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReachedPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/uplift" : { "get" : { "summary" : "Uplift with confidence interval information", "description" : "The percentage difference in visit rate between measured people and a matching group of unexposed people.", "operationId" : "getCampaignUplift", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Uplift1" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/kpis/visit-rate" : { "get" : { "summary" : "Visit Rate", "description" : "The percentage of measured people that visited a store within the conversion window.", "operationId" : "getCampaignVisitRate", "tags" : [ "KPIs V2 - Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VisitRate" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports" : { "get" : { "summary" : "All reports", "description" : "All reports of a campaign", "operationId" : "getCampaignReports", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetReportsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "post" : { "summary" : "Creates a report", "description" : "Creates a campaign report optionally setting an external reference", "operationId" : "createCampaignReport", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCampaignReportRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}" : { "get" : { "summary" : "Report", "description" : "A report of a campaign", "operationId" : "getCampaignReport", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report or Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "summary" : "Delete a report", "description" : "Delete a campaign's report", "operationId" : "deleteCampaignReport", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "204" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report or Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/cuts" : { "get" : { "summary" : "All cut combinations", "operationId" : "getCampaignReportCuts", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cut" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/dwell-time" : { "get" : { "summary" : "Dwell Time", "description" : "Understand how long exposed and control visitors spend in-store when they make a visit, grouped by time interval.", "operationId" : "getCampaignReportDwellTime", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DwellTime" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/impressions" : { "get" : { "summary" : "Impressions", "description" : "A total count of impressions served.", "operationId" : "getCampaignReportImpression", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Impressions" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/incremental-visits" : { "get" : { "summary" : "Incremental Projected Visits", "description" : "The number of projected visits that can be attributed to campaign exposure.", "operationId" : "getCampaignReportIncrementalVisits", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IncrementalVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/kpi-analysis-by-cut" : { "get" : { "summary" : "Kpi Analysis By Cut", "operationId" : "getCampaignReportKpiAnalysisByCut", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KpiAnalysisByCut" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/measured-people" : { "get" : { "summary" : "Measured People", "description" : "Reached people who are also in Cuebiq’s universe of devices.", "operationId" : "getCampaignReportMeasuredPeople", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/measured-visits" : { "get" : { "summary" : "Measured Visits", "description" : "The total number of visits made by measured people within the conversion window.", "operationId" : "getCampaignReportMeasuredVisits", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/performance" : { "get" : { "summary" : "Performance KPIs Snapshot", "description" : "Get a snapshot of all performance kpis at a given date.", "operationId" : "getCampaignReportPerformanceKpis", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "date", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PerformanceKpis" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/projected-visits" : { "get" : { "summary" : "Projected Visits", "description" : "An estimate of how many visits we would have seen if all reached people were in Cuebiq’s panel. \n In other words, measured visits projected to align with the estimated number of reached people.", "operationId" : "getCampaignReportProjectedVisits", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectedVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/reached-people" : { "get" : { "summary" : "Reached People", "description" : "An estimate of people exposed to an impression in the campaign", "operationId" : "getCampaignReportReachedPeople", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReachedPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/uplift" : { "get" : { "summary" : "Uplift with confidence interval information", "description" : "The percentage difference in visit rate between measured people and a matching group of unexposed people.", "operationId" : "getCampaignReportUplift", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Uplift1" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/kpis/visit-rate" : { "get" : { "summary" : "Visit Rate", "description" : "The percentage of measured people that visited a store within the conversion window.", "operationId" : "getCampaignReportVisitRate", "tags" : [ "KPIs V2 - Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VisitRate" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/pixels" : { "put" : { "summary" : "Update Pixel URLs", "description" : "\n Update pixel URLs for a specific DSP given a set of configurations.\n Currently existing pixels will be replaced with the ones deriving from the configurations sent.\n ", "operationId" : "updateCampaignReportPixels", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCampaignReportPixelRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DspPixels" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report, Campaign, or DSP not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "get" : { "summary" : "Report's pixels", "description" : "\n Get pixels for a report grouped by DSP id.\n Optionally, pixels can be filtered by using one or more dspId query parameters.\n \n For Example:\n ```GET /customers/{customerId}/campaigns/{campaignId}/reports?dspId=87c88258-6046-4947-8cd6-68ae2c4576f1&dspId=90df1bd2-c7de-4be9-a232-dd53a5f0aa78```\n ", "operationId" : "getCampaignReportPixels", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "dspId", "in" : "query", "schema" : { "type" : "array", "items" : { "format" : "uuid", "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type" : "string" } }, "required" : true } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetDspPixelsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report or Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "delete" : { "summary" : "Delete Pixel URLs", "description" : "\n Delete pixel URLs for a report.\n If specified as query parameters, pixels can be deleted for one or more DSP.\n \n To delete all pixels for all DSPs:\n ```DELETE /customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/pixels``\n \n To delete pixels for one or more DSPs:\n ```DELETE /customers/{customerId}/campaigns/{campaignId}/reports/{reportId}/pixels?dspId=87c88258-6046-4947-8cd6-68ae2c4576f1&dspId=90df1bd2-c7de-4be9-a232-dd53a5f0aa78``\n ", "operationId" : "deleteCampaignReportPixels", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "dspId", "in" : "query", "schema" : { "type" : "array", "items" : { "format" : "uuid", "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type" : "string" } }, "required" : true } ], "responses" : { "204" : { "description" : "Request succeeded" }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report, Campaign, or DSP not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } }, "post" : { "summary" : "Creates Pixel URLs", "description" : "\n Creates a set of pixel URLs for a specific DSP given a set of configurations.\n The new pixels will be added to the current existing set for the DSP id set in the body request. \n ", "operationId" : "createCampaignReportPixels", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CreateCampaignReportPixelRequest" } } }, "required" : true }, "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DspPixels" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report or Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns" : { "get" : { "summary" : "All campaigns shared with your organizations", "description" : "Get the list of all campaigns shared with your organizations optionally filtered by external_ref", "operationId" : "getSharedCampaigns", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "externalRef", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetCampaignsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}" : { "get" : { "summary" : "A campaign shared with your organization", "description" : "Get information about a campaign shared with your organization.", "operationId" : "getSharedCampaign", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Campaign" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/impressions" : { "get" : { "summary" : "Impressions", "description" : "A total count of impressions served.", "operationId" : "getSharedCampaignImpression", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Impressions" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/incremental-visits" : { "get" : { "summary" : "Incremental Projected Visits", "description" : "The number of projected visits that can be attributed to campaign exposure.", "operationId" : "getSharedCampaignIncrementalVisits", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IncrementalVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/measured-people" : { "get" : { "summary" : "Measured People", "description" : "Reached people who are also in Cuebiq’s universe of devices.", "operationId" : "getSharedCampaignMeasuredPeople", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/measured-visits" : { "get" : { "summary" : "Measured Visits", "description" : "The total number of visits made by measured people within the conversion window.", "operationId" : "getSharedCampaignMeasuredVisits", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/projected-visits" : { "get" : { "summary" : "Measured Visits", "description" : "The total number of visits made by measured people within the conversion window.", "operationId" : "getSharedCampaignProjectedVisits", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectedVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/rankings" : { "get" : { "summary" : "Performance Rankings", "description" : "Get performance rankings on reports grouped by KPIs.", "operationId" : "getSharedCampaignRankings", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PerformanceRankingResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/reached-people" : { "get" : { "summary" : "Reached People", "description" : "An estimate of people exposed to an impression in the campaign", "operationId" : "getSharedCampaignReachedPeople", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReachedPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/uplift" : { "get" : { "summary" : "Uplift with confidence interval information", "description" : "The percentage difference in visit rate between measured people and a matching group of unexposed people.", "operationId" : "getSharedCampaignUplift", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Uplift1" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/kpis/visit-rate" : { "get" : { "summary" : "Visit Rate", "description" : "The percentage of measured people that visited a store within the conversion window.", "operationId" : "getSharedCampaignVisitRate", "tags" : [ "KPIs V2 - Shared Campaigns" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VisitRate" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports" : { "get" : { "summary" : "Shared Campaign's Reports", "description" : "All reports of a campaign shared with your organization", "operationId" : "getSharedCampaignReports", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetReportsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Campaign not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}" : { "get" : { "summary" : "Shared Campaign's Report", "description" : "Get a report belonging to a campaign shared with your organization.", "operationId" : "getSharedCampaignReport", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetReportsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/cuts" : { "get" : { "summary" : "All cut combinations", "operationId" : "getSharedCampaignReportCuts", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cut" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/dwell-time" : { "get" : { "summary" : "Dwell Time", "description" : "Understand how long exposed and control visitors spend in-store when they make a visit, grouped by time interval.", "operationId" : "getSharedCampaignReportDwellTime", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DwellTime" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/impressions" : { "get" : { "summary" : "Impressions", "description" : "A total count of impressions served.", "operationId" : "getSharedCampaignReportImpression", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Impressions" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/incremental-visits" : { "get" : { "summary" : "Incremental Projected Visits", "description" : "The number of projected visits that can be attributed to campaign exposure.", "operationId" : "getSharedCampaignReportIncrementalVisits", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IncrementalVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/kpi-analysis-by-cut" : { "get" : { "summary" : "Kpi Analysis By Cut", "operationId" : "getSharedCampaignReportKpiAnalysisByCut", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KpiAnalysisByCut" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/measured-people" : { "get" : { "summary" : "Measured People", "description" : "Reached people who are also in Cuebiq’s universe of devices.", "operationId" : "getSharedCampaignReportMeasuredPeople", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/measured-visits" : { "get" : { "summary" : "Measured Visits", "description" : "The total number of visits made by measured people within the conversion window.", "operationId" : "getSharedCampaignReportMeasuredVisits", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/projected-visits" : { "get" : { "summary" : "Projected Visits", "description" : "An estimate of how many visits we would have seen if all reached people were in Cuebiq’s panel. \n In other words, measured visits projected to align with the estimated number of reached people.", "operationId" : "getSharedCampaignReportProjectedVisits", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectedVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/reached-people" : { "get" : { "summary" : "Reached People", "description" : "An estimate of people exposed to an impression in the campaign", "operationId" : "getSharedCampaignReportReachedPeople", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReachedPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/uplift" : { "get" : { "summary" : "Uplift with confidence interval information", "description" : "The percentage difference in visit rate between measured people and a matching group of unexposed people.", "operationId" : "getSharedCampaignReportUplift", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Uplift1" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/kpis/visit-rate" : { "get" : { "summary" : "Visit Rate", "description" : "The percentage of measured people that visited a store within the conversion window.", "operationId" : "getSharedCampaignReportVisitRate", "tags" : [ "KPIs V2 - Shared Campaign Reports" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VisitRate" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}/pixels" : { "get" : { "summary" : "Shared Campaign's Report Pixels", "description" : "\n Get pixels, grouped by DSP id, for a report belonging to a campaign shared with your organization.\n Optionally, pixels can be filtered by using one or more dspId query parameters.\n \n To retrieve pixels for all DSPs: \n ```GET /customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}```\n \n To retrieve pixels for two DSPs: \n ```GET /customers/{customerId}/shared/campaigns/{campaignId}/reports/{reportId}?dspId=87c88258-6046-4947-8cd6-68ae2c4576f1&dspId=90df1bd2-c7de-4be9-a232-dd53a5f0aa78```\n ", "operationId" : "getSharedCampaignReportPixels", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "campaignId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "dspId", "in" : "query", "schema" : { "type" : "array", "items" : { "format" : "uuid", "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type" : "string" } }, "required" : true } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetReportsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports" : { "get" : { "summary" : "All shared reports", "description" : "All reports shared with your account's email", "operationId" : "getSharedReports", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetReportsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}" : { "get" : { "summary" : "Shared Report", "description" : "A report shared with your account's email", "operationId" : "getSharedReport", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Report" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/cuts" : { "get" : { "summary" : "All cut combinations", "operationId" : "getSharedReportCuts", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Cut" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/dwell-time" : { "get" : { "summary" : "Dwell Time", "description" : "Understand how long exposed and control visitors spend in-store when they make a visit, grouped by time interval.", "operationId" : "getSharedReportDwellTime", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DwellTime" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/impressions" : { "get" : { "summary" : "Impressions", "description" : "A total count of impressions served.", "operationId" : "getSharedReportImpression", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Impressions" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/incremental-visits" : { "get" : { "summary" : "Incremental Projected Visits", "description" : "The number of projected visits that can be attributed to campaign exposure.", "operationId" : "getSharedReportIncrementalVisits", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IncrementalVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/kpi-analysis-by-cut" : { "get" : { "summary" : "Kpi Analysis By Cut", "operationId" : "getSharedReportKpiAnalysisByCut", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/KpiAnalysisByCut" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/measured-people" : { "get" : { "summary" : "Measured People", "description" : "Reached people who are also in Cuebiq’s universe of devices.", "operationId" : "getSharedReportMeasuredPeople", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/measured-visits" : { "get" : { "summary" : "Measured Visits", "description" : "The total number of visits made by measured people within the conversion window.", "operationId" : "getSharedReportMeasuredVisits", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MeasuredVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/projected-visits" : { "get" : { "summary" : "Projected Visits", "description" : "An estimate of how many visits we would have seen if all reached people were in Cuebiq’s panel. \n In other words, measured visits projected to align with the estimated number of reached people.", "operationId" : "getSharedReportProjectedVisits", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ProjectedVisits" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/reached-people" : { "get" : { "summary" : "Reached People", "description" : "An estimate of people exposed to an impression in the campaign", "operationId" : "getSharedReportReachedPeople", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReachedPeople" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/uplift" : { "get" : { "summary" : "Uplift with confidence interval information", "description" : "The percentage difference in visit rate between measured people and a matching group of unexposed people.", "operationId" : "getSharedReportUplift", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Uplift1" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/kpis/visit-rate" : { "get" : { "summary" : "Visit Rate", "description" : "The percentage of measured people that visited a store within the conversion window.", "operationId" : "getSharedReportVisitRate", "tags" : [ "KPIs V2 - Shared Reports" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "allOf" : [ { }, { "$ref" : "#/components/schemas/UUID" } ] } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VisitRate" } } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/customers/{customerId}/shared/reports/{reportId}/pixels" : { "get" : { "summary" : "Shared Report's Pixels", "description" : "\n Get pixels, grouped by DSP id, for a report shared with your account's email.\n Optionally, pixels can be filtered by using one or more dspId query parameters.\n \n To retrieve pixels for all DSPs: \n ```GET /customers/{customerId}/shared/reports/{reportId}/pixels```\n \n To retrieve pixels for two DSPs: \n ```GET /customers/{customerId}/shared/reports/{reportId}/pixels?dspId=87c88258-6046-4947-8cd6-68ae2c4576f1&dspId=90df1bd2-c7de-4be9-a232-dd53a5f0aa78```\n ", "operationId" : "getSharedReportPixels", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "customerId", "in" : "path", "required" : true, "schema" : { "format" : "int32", "type" : "integer" } }, { "name" : "reportId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } }, { "name" : "dspId", "in" : "query", "schema" : { "type" : "array", "items" : { "format" : "uuid", "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type" : "string" } }, "required" : true } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetDspPixelsResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Report not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/dsp" : { "get" : { "summary" : "Get DSPs", "description" : "Get DSPs filtering by search param (name or description)", "operationId" : "getDSPs", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "id", "in" : "query", "schema" : { "type" : "array", "items" : { "format" : "uuid", "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type" : "string" } }, "required" : true }, { "name" : "search", "in" : "query", "schema" : { "type" : "string", "nullable" : true } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GetDspResponse" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } }, "/v2/dsp/{dspId}" : { "get" : { "summary" : "Get a DSP", "description" : "Get a single DSP by its id", "operationId" : "getDSP", "tags" : [ "Measurement V2" ], "parameters" : [ { "name" : "dspId", "in" : "path", "required" : true, "schema" : { "$ref" : "#/components/schemas/UUID" } } ], "responses" : { "200" : { "description" : "Request succeeded", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dsp" } } } }, "401" : { "description" : "User not authorized!", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "403" : { "description" : "User not authorized to perform operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "404" : { "description" : "Kpi data unavailable", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } }, "500" : { "description" : "Internal server error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ErrorMessage" } } } } } } } }, "components" : { "securitySchemes" : { "cuebiq_auth" : { "type" : "oauth2", "flows" : { "clientCredentials" : { "tokenUrl" : "https://auth.cuebiq.com/auth/realms/Customers/protocol/openid-connect/token", "refreshUrl" : "https://auth.cuebiq.com/auth/realms/Customers/protocol/openid-connect/token" } } } }, "schemas" : { "Campaign" : { "required" : [ "id", "name", "flightDateRange", "conversionIntervalRange", "status", "reports" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "brandId" : { "format" : "int32", "type" : "integer" }, "flightDateRange" : { "$ref" : "#/components/schemas/LocalDateRange" }, "conversionWindow" : { "format" : "int32", "type" : "integer" }, "conversionIntervalRange" : { "$ref" : "#/components/schemas/LocalDateRange" }, "externalRef" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string" }, "reports" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ReportSummary" } } } }, "CampaignPerformanceKpis" : { "required" : [ "campaignId", "kpis" ], "type" : "object", "properties" : { "campaignId" : { "$ref" : "#/components/schemas/UUID" }, "kpis" : { "$ref" : "#/components/schemas/PerformanceKpis" } } }, "ConversionFeed" : { "required" : [ "feedId", "name", "startDate", "endDate", "deliveries", "status" ], "type" : "object", "properties" : { "feedId" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "startDate" : { "$ref" : "#/components/schemas/LocalDate" }, "endDate" : { "$ref" : "#/components/schemas/LocalDate" }, "organizationId" : { "format" : "int32", "type" : "integer" }, "deliveries" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/FacadeDeliveryConfig" } }, "status" : { "$ref" : "#/components/schemas/ConversionFeedStatus" } } }, "ConversionFeedStatus" : { "enum" : [ "STAGING", "ACTIVE", "COMPLETED" ], "type" : "string" }, "CreateCampaignReportPixelRequest" : { "required" : [ "dspId", "configurations" ], "type" : "object", "properties" : { "dspId" : { "allOf" : [ { "$ref" : "#/components/schemas/UUID" } ], "nullable" : true }, "configurations" : { "minItems" : 1, "type" : "array", "items" : { "$ref" : "#/components/schemas/PixelConfiguration" }, "nullable" : true } } }, "CreateCampaignReportRequest" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "maxLength" : 64, "minLength" : 3, "type" : "string", "nullable" : true }, "estimatedImpressions" : { "format" : "int32", "maximum" : 100000000, "minimum" : 100000, "type" : "integer", "nullable" : true }, "cpm" : { "format" : "double", "type" : "number", "nullable" : true }, "totalBudget" : { "format" : "double", "minimum" : 0, "exclusiveMinimum" : true, "type" : "number", "nullable" : true }, "externalRef" : { "type" : "string", "nullable" : true }, "deliveryHTTP" : { "type" : "boolean", "nullable" : true }, "deliveryHTTPPostbackURL" : { "type" : "string", "nullable" : true }, "deliveryHTTPAuthToken" : { "type" : "string", "nullable" : true }, "deliveryS3" : { "type" : "boolean", "nullable" : true } } }, "CreateCampaignRequest" : { "required" : [ "name", "brandId", "flightDatesRange", "conversionWindow", "conversionIntervalRange" ], "type" : "object", "properties" : { "name" : { "type" : "string", "nullable" : true }, "brandId" : { "format" : "int32", "type" : "integer", "nullable" : true }, "flightDatesRange" : { "allOf" : [ { "$ref" : "#/components/schemas/LocalDateRange1" } ], "nullable" : true }, "conversionWindow" : { "format" : "int32", "minimum" : 0, "exclusiveMinimum" : true, "type" : "integer", "nullable" : true }, "conversionIntervalRange" : { "allOf" : [ { "$ref" : "#/components/schemas/LocalDateRange1" } ], "nullable" : true }, "externalRef" : { "type" : "string", "nullable" : true } } }, "Cut" : { "required" : [ "parameters" ], "type" : "object", "properties" : { "impressions" : { "format" : "double", "type" : "number" }, "measuredVisits" : { "format" : "double", "type" : "number" }, "projectedVisits" : { "format" : "double", "type" : "number" }, "walkThroughRate" : { "format" : "double", "type" : "number" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "Dsp" : { "required" : [ "id", "name", "macros" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "description" : { "type" : "string", "nullable" : true }, "macros" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DspMacro" } } } }, "DspMacro" : { "required" : [ "dspId", "name", "macro" ], "type" : "object", "properties" : { "dspId" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "macro" : { "type" : "string" }, "pixelParameter" : { "type" : "string", "nullable" : true }, "description" : { "type" : "string", "nullable" : true } } }, "DspPixels" : { "required" : [ "dspId", "pixels" ], "type" : "object", "properties" : { "dspId" : { "$ref" : "#/components/schemas/UUID" }, "pixels" : { "type" : "array", "items" : { "type" : "string" } } } }, "DwellTime" : { "type" : "object", "properties" : { "start" : { "format" : "int64", "type" : "integer" }, "end" : { "format" : "int64", "type" : "integer" }, "exposed" : { "format" : "int64", "type" : "integer" }, "controlGroup" : { "format" : "int64", "type" : "integer" } } }, "ErrorMessage" : { "required" : [ "timestamp", "details" ], "type" : "object", "properties" : { "status" : { "format" : "int32", "type" : "integer" }, "message" : { "type" : "string", "nullable" : true }, "link" : { "type" : "string", "nullable" : true }, "timestamp" : { "$ref" : "#/components/schemas/ZonedDateTime" }, "details" : { "type" : "array", "items" : { "type" : "string" } } } }, "FacadeDeliveryConfig" : { "type" : "object" }, "Geoset" : { "required" : [ "id", "name", "geosetStatus" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "externalRef" : { "type" : "string", "nullable" : true }, "geosetStatus" : { "type" : "string" } } }, "GeosetFilter" : { "type" : "object", "properties" : { "dmas" : { "type" : "array", "items" : { "type" : "string" }, "nullable" : true }, "states" : { "type" : "array", "items" : { "type" : "string" }, "nullable" : true } } }, "GeosetS3PreSignedUrlResponse" : { "required" : [ "presignedUrl", "objectUrl", "expiration" ], "type" : "object", "properties" : { "presignedUrl" : { "type" : "string" }, "objectUrl" : { "type" : "string" }, "expiration" : { "$ref" : "#/components/schemas/ZonedDateTime" } } }, "GetCampaignsResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Campaign" } } } }, "GetConversionFeedsResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConversionFeed" } }, "page" : { "format" : "int32", "type" : "integer" }, "size" : { "format" : "int32", "type" : "integer" }, "totalElements" : { "format" : "int64", "type" : "integer" }, "totalPages" : { "format" : "int32", "type" : "integer" } } }, "GetDspPixelsResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DspPixels" } } } }, "GetDspResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Dsp" } } } }, "GetGeosetsResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Geoset" } } } }, "GetPlacesResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "count" : { "format" : "int32", "type" : "integer" }, "nextFromId" : { "format" : "int64", "type" : "integer", "nullable" : true }, "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Place" } } } }, "GetReportsResponse" : { "required" : [ "items" ], "type" : "object", "properties" : { "items" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Report" } } } }, "Impressions" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" } } }, "IncrementalVisits" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" }, "lowerBound" : { "format" : "double", "type" : "number" }, "upperBound" : { "format" : "double", "type" : "number" } } }, "KpiAnalysisByCut" : { "required" : [ "runDate", "uplift", "parameters" ], "type" : "object", "properties" : { "runDate" : { "$ref" : "#/components/schemas/LocalDate" }, "impressions" : { "format" : "double", "type" : "number" }, "measuredPeople" : { "format" : "int64", "type" : "integer" }, "reachedPeople" : { "format" : "double", "type" : "number" }, "uplift" : { "$ref" : "#/components/schemas/Uplift" }, "projectedIncrementalVisits" : { "format" : "double", "type" : "number" }, "visitRate" : { "format" : "double", "type" : "number" }, "measuredVisits" : { "format" : "double", "type" : "number" }, "projectedVisits" : { "format" : "double", "type" : "number" }, "walkThroughRate" : { "format" : "double", "type" : "number" }, "parameters" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "KpiDouble" : { "required" : [ "date", "value" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" } } }, "KpiLong" : { "required" : [ "date", "value" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "int64", "type" : "integer" } } }, "KpiWithConfidenceInfo" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" }, "lowerBound" : { "format" : "double", "type" : "number" }, "upperBound" : { "format" : "double", "type" : "number" }, "confidenceIndex" : { "format" : "double", "type" : "number", "nullable" : true } } }, "LocalDate" : { "format" : "date", "type" : "string", "example" : "2022-03-10" }, "LocalDateRange" : { "required" : [ "start", "end" ], "type" : "object", "properties" : { "start" : { "$ref" : "#/components/schemas/LocalDate" }, "end" : { "$ref" : "#/components/schemas/LocalDate" } } }, "LocalDateRange1" : { "required" : [ "start", "end" ], "type" : "object", "properties" : { "start" : { "allOf" : [ { "$ref" : "#/components/schemas/LocalDate" } ], "nullable" : true }, "end" : { "allOf" : [ { "$ref" : "#/components/schemas/LocalDate" } ], "nullable" : true } } }, "LocalTime" : { "format" : "local-time", "type" : "string", "externalDocs" : { "description" : "As defined by 'partial-time' in RFC3339", "url" : "https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6" }, "example" : "13:45:30.123456789" }, "MeasuredPeople" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "int64", "type" : "integer" } } }, "MeasuredVisits" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "int64", "type" : "integer" } } }, "PerformanceKpis" : { "required" : [ "uplift", "cumulativeImpressions", "cumulativeMeasuredVisits", "cumulativeProjectedVisits", "exposedVisitRate", "cumulativeReachedPeople", "incrementalityRatio", "projectedIncrementalVisits", "cumulativeMeasuredPeople" ], "type" : "object", "properties" : { "uplift" : { "$ref" : "#/components/schemas/KpiWithConfidenceInfo" }, "cumulativeImpressions" : { "$ref" : "#/components/schemas/KpiDouble" }, "cumulativeMeasuredVisits" : { "$ref" : "#/components/schemas/KpiLong" }, "cumulativeProjectedVisits" : { "$ref" : "#/components/schemas/KpiDouble" }, "exposedVisitRate" : { "$ref" : "#/components/schemas/KpiDouble" }, "cumulativeReachedPeople" : { "$ref" : "#/components/schemas/KpiDouble" }, "incrementalityRatio" : { "$ref" : "#/components/schemas/KpiDouble" }, "costPerVisit" : { "allOf" : [ { "$ref" : "#/components/schemas/KpiDouble" } ], "nullable" : true }, "costPerIncrementalVisit" : { "allOf" : [ { "$ref" : "#/components/schemas/KpiDouble" } ], "nullable" : true }, "projectedIncrementalVisits" : { "$ref" : "#/components/schemas/KpiDouble" }, "cumulativeMeasuredPeople" : { "$ref" : "#/components/schemas/KpiLong" } } }, "PerformanceRankingResponse" : { "required" : [ "rankings" ], "type" : "object", "properties" : { "rankings" : { "type" : "object", "additionalProperties" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RankedKpi" } } } } }, "PixelConfiguration" : { "required" : [ "deviceId", "impressionId", "latitude", "longitude", "clientId", "creativeName", "creativeType", "publisherId", "placementId", "permutations" ], "type" : "object", "properties" : { "deviceId" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "impressionId" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "latitude" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "longitude" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "clientId" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "creativeName" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "creativeType" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "publisherId" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "placementId" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "permutations" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PixelPermutation" }, "nullable" : true } } }, "PixelPermutation" : { "required" : [ "sid1", "sid2", "sid3", "sid4" ], "type" : "object", "properties" : { "sid1" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "sid2" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "sid3" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true }, "sid4" : { "minLength" : 1, "pattern" : "\\S", "type" : "string", "nullable" : true } } }, "Place" : { "required" : [ "name", "address" ], "type" : "object", "properties" : { "id" : { "format" : "int64", "type" : "integer" }, "name" : { "type" : "string" }, "address" : { "type" : "string" }, "city" : { "type" : "string", "nullable" : true }, "latitude" : { "format" : "double", "type" : "number" }, "longitude" : { "format" : "double", "type" : "number" }, "radiusMeters" : { "format" : "double", "type" : "number" } } }, "PlaceDwellTimeMinutesRaw" : { "required" : [ "first", "second" ], "type" : "object", "properties" : { "first" : { "format" : "int32", "minimum" : 0, "exclusiveMinimum" : true, "type" : "integer", "nullable" : true }, "second" : { "format" : "int32", "minimum" : 0, "exclusiveMinimum" : true, "type" : "integer", "nullable" : true } } }, "PlaceOpeningHoursRangeRaw" : { "required" : [ "from", "to" ], "type" : "object", "properties" : { "from" : { "allOf" : [ { "$ref" : "#/components/schemas/LocalTime" } ], "nullable" : true }, "to" : { "allOf" : [ { "$ref" : "#/components/schemas/LocalTime" } ], "nullable" : true } } }, "PlaceOpeningHoursRaw" : { "required" : [ "mon", "tue", "wed", "thu", "fri", "sat", "sun" ], "type" : "object", "properties" : { "mon" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true }, "tue" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true }, "wed" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true }, "thu" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true }, "fri" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true }, "sat" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true }, "sun" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PlaceOpeningHoursRangeRaw" }, "nullable" : true } } }, "PostGeosetRequestBodyRaw" : { "required" : [ "name", "placesFileLocation", "placeRadiusMeters", "placeDwellTimeMinutes", "placeOpeningHours" ], "type" : "object", "properties" : { "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "\\S", "type" : "string", "nullable" : true }, "externalRef" : { "type" : "string", "nullable" : true }, "placesFileLocation" : { "pattern" : "\\S", "type" : "string", "nullable" : true }, "placeRadiusMeters" : { "format" : "double", "minimum" : 0, "exclusiveMinimum" : true, "type" : "number", "nullable" : true }, "placeDwellTimeMinutes" : { "allOf" : [ { "$ref" : "#/components/schemas/PlaceDwellTimeMinutesRaw" } ], "nullable" : true }, "placeOpeningHours" : { "allOf" : [ { "$ref" : "#/components/schemas/PlaceOpeningHoursRaw" } ], "nullable" : true } } }, "PostGeosetResponse" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" } } }, "ProjectedVisits" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" } } }, "RankedKpi" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "rank" : { "format" : "int32", "type" : "integer", "nullable" : true }, "value" : { "format" : "double", "type" : "number", "nullable" : true } } }, "ReachedPeople" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" } } }, "Report" : { "required" : [ "id", "name", "status" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" }, "externalRef" : { "type" : "string", "nullable" : true }, "status" : { "type" : "string" }, "budget" : { "format" : "double", "type" : "number", "nullable" : true } } }, "ReportSummary" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "id" : { "$ref" : "#/components/schemas/UUID" }, "name" : { "type" : "string" } } }, "UUID" : { "format" : "uuid", "pattern" : "[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}", "type" : "string" }, "UpdateCampaignGeosetRequest" : { "required" : [ "geosetId" ], "type" : "object", "properties" : { "geosetId" : { "allOf" : [ { "$ref" : "#/components/schemas/UUID" } ], "nullable" : true }, "geosetFilter" : { "allOf" : [ { "$ref" : "#/components/schemas/GeosetFilter" } ], "nullable" : true } } }, "Uplift" : { "type" : "object", "properties" : { "value" : { "format" : "double", "type" : "number" }, "lowerBound" : { "format" : "double", "type" : "number" }, "upperBound" : { "format" : "double", "type" : "number" }, "confidenceIndex" : { "format" : "double", "type" : "number" } } }, "Uplift1" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" }, "lowerBound" : { "format" : "double", "type" : "number" }, "upperBound" : { "format" : "double", "type" : "number" }, "confidenceIndex" : { "format" : "double", "type" : "number" } } }, "VisitRate" : { "required" : [ "date" ], "type" : "object", "properties" : { "date" : { "$ref" : "#/components/schemas/LocalDate" }, "value" : { "format" : "double", "type" : "number" } } }, "ZonedDateTime" : { "format" : "date-time", "type" : "string", "example" : "2022-03-10T12:15:50-04:00" } } } }