> ## Documentation Index > Fetch the complete documentation index at: https://docs.topsort.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Campaign Video Report > Get a video campaign's total behavioral summary and video playback report between given dates. ## OpenAPI ````yaml /openapi.json get /public/v1/reporting-service/campaigns/{campaign_id}/video openapi: 3.1.0 info: title: Topsort Endpoints v2 API Reference description: > In order for a storefront to be able to run auctions in Topsort and report auction-related events back to Topsort, both the `/v2/auctions` and `/v2/events` endpoints must be integrated. Below are the endpoint and model definitions for each. contact: email: wicha@topsort.com license: name: Apache 2.0 url: http://www.apache.org/licenses/LICENSE-2.0.html x-logo: url: https://assets.topsort.com/Topsort_logo_icon_dark.svg backgroundColor: '#fff' altText: Topsort version: 2.0.0 servers: - url: https://api.topsort.com description: Base API URL security: [] tags: - name: Auctions description: >- An auction determines which products should be promoted based on the vendors' bids. - name: Events description: >- Events are sent to Topsort as part of the attribution and reporting journey. - name: Toptimize description: > An out-of-the-box solution for prediction, ranking, retrieval, and other elements of ad selection. - name: Toppie API description: Toppie management API. - name: Campaign API description: Full-featured campaign management API for banners and sponsored listings. - name: Catalog API description: Products catalog management API. - name: Billing API description: Marketplace and Vendor Billing management API. - name: Reporting API description: Marketplace, Vendor, Campaign, and product reporting API. - name: Invitation API description: Vendor invitations management API. - name: User API description: User management API. - name: Webhooks API description: Webhooks API that allows event-driven automation. - name: Assets API description: Assets management API. - name: Segments Service description: Segments Service. - name: Forecasting Service description: Toptimize Forecasting Service. - name: Offsite Ads API description: Offsite Ads API that allows to manage offsite ads campaigns. - name: Media API description: Ad configuration API. - name: Placement API description: Placement management API for sponsored brand slots. - name: Export API description: Request an asynchronous Parquet export of your performance data. paths: /public/v1/reporting-service/campaigns/{campaign_id}/video: get: tags: - Reporting API summary: Get Campaign Video Report description: >- Get a video campaign's total behavioral summary and video playback report between given dates. operationId: get_campaign_video_report parameters: - name: campaign_id in: path required: true schema: type: string format: uuid description: The ID of the campaign. title: Campaign Id description: The ID of the campaign. - name: start_date in: query required: true schema: type: string format: date description: The start date for which reports will be generated. title: Start Date description: The start date for which reports will be generated. - name: end_date in: query required: true schema: type: string format: date description: The end date for which reports will be generated. title: End Date description: The end date for which reports will be generated. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Advanced_APIs_CampaignVideoReport' '404': description: >- Campaign not found in the marketplace, or not a v2 video campaign (created with `mediaType: video`). v1 video campaigns, which have no media type, are not supported. '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/Advanced_APIs_HTTPValidationError' security: - Advanced_APIs_HTTPBearer: [] components: schemas: Advanced_APIs_CampaignVideoReport: properties: impressions: $ref: '#/components/schemas/Advanced_APIs_Events' description: How many impressions are attributed to this report item. clicks: $ref: '#/components/schemas/Advanced_APIs_Events' description: How many clicks are attributed to this report item. purchases: $ref: '#/components/schemas/Advanced_APIs_CampaignPurchases' description: >- How many purchases are attributed to this report item, split by attribution. auctions: $ref: '#/components/schemas/Advanced_APIs_Auctions' description: How many auctions are attributed to this report item. viewability: type: number title: Viewability description: >- Viewability: viewable impressions over the marketplace's configured denominator. Proxy (impressions / auctions_won) for most marketplaces; IAB (impressions / renders) for marketplaces that emit render events. Not capped, so a value above 1 signals inconsistent data rather than being silently hidden. renders: format: int64 title: Renders description: >- Count of render events (ads placed in the DOM). Present only for marketplaces that emit render events (null otherwise). oneOf: - type: integer - type: 'null' video: $ref: '#/components/schemas/Advanced_APIs_VideoMetrics' description: Video playback events attributed to this campaign. type: object required: - impressions - clicks - purchases - auctions - viewability - video title: CampaignVideoReport description: Campaign-grain report plus video playback events, for video campaigns. Advanced_APIs_HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/Advanced_APIs_ValidationError' type: array title: Detail type: object title: HTTPValidationError Advanced_APIs_Events: properties: total: type: integer format: int64 title: Total description: Total number of events. charged: type: integer format: int64 title: Charged description: Number of charged events. adSpent: type: integer format: int64 title: Adspent description: >- Ad spent over a period of time, in minor units of currency according to ISO 4217. adSpentDecimal: title: Adspentdecimal description: Ad spent over a period of time. oneOf: - type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ - type: 'null' type: object required: - total - charged - adSpent title: Events description: Aggregation of events. Advanced_APIs_CampaignPurchases: properties: amount: type: integer format: int64 title: Amount description: >- Amount of money made by purchases over a period of time, in minor units of currency according to ISO 4217. count: type: integer format: int64 title: Count description: Amount of purchase events. quantity: type: integer format: int64 title: Quantity description: Amount of items purchased. countByProduct: title: Countbyproduct description: >- Purchase count by product. Available if `count_by_product` is set to `true`. oneOf: - additionalProperties: type: integer type: object - type: 'null' direct: $ref: '#/components/schemas/Advanced_APIs_Purchases' description: Sales directly attributed to the advertised product. indirect: $ref: '#/components/schemas/Advanced_APIs_Purchases' description: >- Sales attributed to other products purchased after interacting with the ad (halo sales). type: object required: - amount - count - quantity - direct - indirect title: CampaignPurchases description: >- Aggregation of purchase events for a campaign, additionally split by attribution. Advanced_APIs_Auctions: properties: percentageWon: type: number title: Percentagewon description: Percentage of auctions won for a campaign in a given period of time. won: type: integer title: Won description: Number of auctions won for a campaign in a given period of time. lost: type: integer title: Lost description: Number of auctions lost for a campaign in a given period of time. type: object required: - percentageWon - won - lost title: Auctions description: Aggregation for auctions. Advanced_APIs_VideoMetrics: properties: playStarts: type: integer format: int64 title: Playstarts description: Number of times the video started playing. firstQuartiles: type: integer format: int64 title: Firstquartiles description: Number of times the video played to 25% of its duration. midpoints: type: integer format: int64 title: Midpoints description: Number of times the video played to 50% of its duration. thirdQuartiles: type: integer format: int64 title: Thirdquartiles description: Number of times the video played to 75% of its duration. completes: type: integer format: int64 title: Completes description: Number of times the video played to completion. errors: type: integer format: int64 title: Errors description: Number of video playback errors. type: object required: - playStarts - firstQuartiles - midpoints - thirdQuartiles - completes - errors title: VideoMetrics description: Video playback events attributed to this report item. Advanced_APIs_ValidationError: properties: loc: items: oneOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type type: object required: - loc - msg - type title: ValidationError Advanced_APIs_Purchases: properties: amount: type: integer format: int64 title: Amount description: >- Amount of money made by purchases over a period of time, in minor units of currency according to ISO 4217. count: type: integer format: int64 title: Count description: Amount of purchase events. quantity: type: integer format: int64 title: Quantity description: Amount of items purchased. countByProduct: title: Countbyproduct description: >- Purchase count by product. Available if `count_by_product` is set to `true`. oneOf: - additionalProperties: type: integer type: object - type: 'null' type: object required: - amount - count - quantity title: Purchases description: Aggregation of purchase events. securitySchemes: Advanced_APIs_HTTPBearer: type: http description: >- A valid API key generated in Topsort's UI. Use the TSE API key if calling auctions or events API, otherwise use the TSC API key. scheme: bearer ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.