facebook-nodejs-business-sdk/src/objects/instagram-insights-result.js

SDK for the Facebook Ads API in Javascript and Node.js

/**
 * Copyright (c) 2017-present, Facebook, Inc.
 * All rights reserved.
 *
 * This source code is licensed under the license found in the
 * LICENSE file in the root directory of this source tree.
 * @flow
 */
import {AbstractCrudObject} from './../abstract-crud-object';

/**
 * InstagramInsightsResult
 * @extends AbstractCrudObject
 * @see {@link https://developers.facebook.com/docs/marketing-api/}
 */
export default class InstagramInsightsResult extends AbstractCrudObject {
  static get Fields () {
    return Object.freeze({
      description: 'description',
      id: 'id',
      name: 'name',
      period: 'period',
      title: 'title',
      values: 'values'
    });
  }

  static get Metric (): Object {
    return Object.freeze({
      impressions: 'impressions',
      reach: 'reach',
      carousel_album_impressions: 'carousel_album_impressions',
      carousel_album_reach: 'carousel_album_reach',
      carousel_album_engagement: 'carousel_album_engagement',
      carousel_album_saved: 'carousel_album_saved',
      carousel_album_video_views: 'carousel_album_video_views',
      taps_forward: 'taps_forward',
      taps_back: 'taps_back',
      exits: 'exits',
      replies: 'replies',
      engagement: 'engagement',
      saved: 'saved',
      video_views: 'video_views'
    });
  }
  static get Period (): Object {
    return Object.freeze({
      day: 'day',
      week: 'week',
      days_28: 'days_28',
      month: 'month',
      lifetime: 'lifetime'
    });
  }

  get (fields, params): InstagramInsightsResult {
    return this.read(
      fields,
      params
    );
  }
}