Get Video Metrics with YouTube (Analytics API) API

Pipedream makes it easy to connect APIs for YouTube (Analytics API) and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

Get Video Metrics with the YouTube (Analytics API) API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to Get Video Metrics with the YouTube (Analytics API) API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the Get Video Metrics action
1. Connect your YouTube (Analytics API) account
2. Configure Hidden Reloader
3. Configure Start Date
4. Configure End Date
5. Optional- Select one or more Dimensions
6. Optional- Configure Sort
7. Optional- Configure Max Results
8. Configure Video ID
9. Select one or more Metrics
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

Get Video Metrics with YouTube (Analytics API) API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + YouTube (Analytics API)

Try it

Get Video Metrics with YouTube (Analytics API) API on New Submission from Typeform API

Typeform + YouTube (Analytics API)

Try it

Get Video Metrics with YouTube (Analytics API) API on New Submission (Instant) from Jotform API

Jotform + YouTube (Analytics API)

Try it

Get Video Metrics with YouTube (Analytics API) API on New Scheduled Tasks from Pipedream API

Pipedream + YouTube (Analytics API)

Try it

Get Video Metrics with YouTube (Analytics API) API on New Download Counts from npm API

npm + YouTube (Analytics API)

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Get Video Metrics on YouTube (Analytics API)

Description:Retrieve detailed analytics for a specific video. [See the documentation](https://developers.google.com/youtube/analytics/reference/reports/query)

Version:0.0.1

Key:youtube_analytics_api-get-video-metrics

View on GitHub

Code#

import common from "../common/reports-query.mjs";
import utils from "../../common/utils.mjs";
import propsFragments from "../../common/props-fragments.mjs";

export default {
  ...common,
  key: "youtube_analytics_api-get-video-metrics",
  name: "Get Video Metrics",
  description: "Retrieve detailed analytics for a specific video. [See the documentation](https://developers.google.com/youtube/analytics/reference/reports/query)",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    videoId: {
      type: "string",
      label: "Video ID",
      description: "The ID of the video for which you want to retrieve metrics. Eg. `pd1FJh59zxQ`.",
    },
    metrics: propsFragments.metrics,
  },
  additionalProps() {
    return this.getIdsProps();
  },
  async run({ $ }) {
    const {
      app,
      videoId,
      getIdsParam,
      startDate,
      endDate,
      metrics,
      dimensions,
      sort,
      maxResults,
    } = this;

    const response = await app.reportsQuery({
      $,
      params: {
        ids: getIdsParam(),
        startDate,
        endDate,
        metrics: utils.arrayToCommaSeparatedList(metrics),
        dimensions: utils.arrayToCommaSeparatedList(dimensions),
        sort: utils.arrayToCommaSeparatedList(sort),
        maxResults,
        filters: `video==${videoId}`,
      },
    });

    $.export("$summary", "Successfully fetched video metrics.");
    return response;
  },
};

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
YouTube (Analytics API)	`app`	`app`	This component uses the YouTube (Analytics API) app.
Start Date	`startDate`	`string`	The start date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format.
End Date	`endDate`	`string`	The end date for fetching YouTube Analytics data. The value should be in `YYYY-MM-DD` format. The API response contains data up until the last day for which all metrics in the query are available at the time of the query. So, for example, if the request specifies an end date of July 5, 2017, and values for all of the requested metrics are only available through July 3, 2017, that will be the last date for which data is included in the response. (That is true even if data for some of the requested metrics is available for July 4, 2017.)
Dimensions	`dimensions`	`string[]`	Select a value from the drop down menu:`adTypeageGroupassetaudienceTypechannelclaimedStatuscontentOwnercountrydaydeviceTypeelapsedVideoTimeRatiogenderinsightPlaybackLocationDetailinsightPlaybackLocationTypeinsightTrafficSourceDetailinsightTrafficSourceTypeliveOrOnDemandoperatingSystemplaylistprovincesharingServicesubscribedStatussubtitleLanguageuploaderTypevideo`
Sort	`sort`	`string[]`	A list of dimensions or metrics that determine the sort order for YouTube Analytics data. By default the sort order is ascending. The `-` prefix causes descending sort order. Eg. `-views`.
Max Results	`maxResults`	`integer`	The maximum number of rows to include in the response.
Video ID	`videoId`	`string`	The ID of the video for which you want to retrieve metrics. Eg. `pd1FJh59zxQ`.
Metrics	`metrics`	`string[]`	Select a value from the drop down menu:`adImpressionsannotationClickableImpressionsannotationClicksannotationClickThroughRateannotationClosableImpressionsannotationClosesannotationCloseRateannotationImpressionsaudienceWatchRatioaverageViewDurationaverageViewPercentagecardClickRatecardClickscardImpressionscardTeaserClickRatecardTeaserClickscardTeaserImpressionscommentscpmdislikesestimatedAdRevenueestimatedMinutesWatchedestimatedRevenuegrossRevenuelikesmonetizedPlaybacksplaybackBasedCpmplaylistStartssavesAddedsavesRemovedsharessubscribersGainedsubscribersLostvideosAddedToPlaylistsvideosRemovedFromPlaylistsviewerPercentageviews`

Authentication#

YouTube (Analytics API) uses OAuth authentication. When you connect your YouTube (Analytics API) account, Pipedream will open a popup window where you can sign into YouTube (Analytics API) and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any YouTube (Analytics API) API.

Pipedream requests the following authorization scopes when you connect your account:

emailprofilehttps://www.googleapis.com/auth/yt-analytics-monetary.readonlyhttps://www.googleapis.com/auth/yt-analytics.readonly

Try it

Query Custom Analytics with the YouTube (Analytics API) API

Execute a custom analytics query using specified metrics, dimensions, filters, and date ranges. Requires query parameters to configure. See the documentation.

Try it