APIAnalytics APIImpressions

Impressions

Method: POST
URL: https://www.wellcomemat.com/api/analytics/impressions.php

Notes:

  1. This endpoint returns the total plays and player impressions for the range. A play is a viewer starting the video, counted the moment playback begins, with no minimum watch time.

  2. You may only use one or none of shared, hash, and filter.

Parameters

KeyTypeDescription
keytext{{key}}
secrettext{{secret}}
start_datetextRequired [YYYY-MM-DD hh:mm:ss]
end_datetextRequired [YYYY-MM-DD hh:mm:ss]
sharedtextIf request Rolled-up Reporting [“true”,“false”]
hashtextFocuses view query on the given Media Hash
filtertextCustom filter can be created (“vv.media_id = 214122”)
debugtext[“true”,“false”]

Response

  • loads is the player impression count plus the estimated view count. An estimated view is a request that downloaded more than 1,000 bytes of a video file from the CDN, or a view YouTube or Facebook reported.

  • views is the larger of the play count and the estimated view count. Both counts include the views YouTube and Facebook report, so adding them would count those views twice.

  • views_percent is views as a percentage of loads.

  • loads_percent is the difference between 100 and views_percent.

type AnalyticsImpressionsResponse = {
  success: 0 | 1;
  data: {
    wm_impressions: number;
    youtube_impressions: number;
    loads: number;
    views: number;
    views_percent: number;
    loads_percent: number;
  };
  google_chart: string; // (with escaped characters)
  error: string;
  warnings: string;
};
Device and Traffic BreakdownPopular