Skip to content

Function: getAccountInsights() ​

ts
function getAccountInsights(client, range?): Promise<{
[key: string]: unknown;
  account_views_by_content_type?:   | {
   [key: string]: unknown;
     entries?: object[];
     total?: number | null;
   }
     | null;
  account_views_count?:   | {
   [key: string]: unknown;
     follow_type_breakdown?:   | {
      [key: string]: unknown;
        follower?:   | {
         [key: string]: unknown;
           value?: number | null;
         }
           | null;
        non_follower?:   | {
         [key: string]: unknown;
           value?: number | null;
         }
           | null;
      }
        | null;
     total?:   | {
      [key: string]: unknown;
        format?: string;
        formatted_value?: string;
        id: string;
        label: string;
        value?: number | null;
      }
        | null;
   }
     | null;
  bio_link_taps?:   | {
   [key: string]: unknown;
     value?: number | null;
   }
     | null;
  business_address_taps?:   | {
   [key: string]: unknown;
     value?: number | null;
   }
     | null;
  interactions_by_content_type?:   | {
   [key: string]: unknown;
     sub_breakdowns?: unknown[];
     total_breakdown?:   | {
      [key: string]: unknown;
        entries?: object[];
        total?: number | null;
      }
        | null;
   }
     | null;
  interactions_count?:   | {
   [key: string]: unknown;
     follower?:   | {
      [key: string]: unknown;
        value?: number | null;
      }
        | null;
     non_follower?:   | {
      [key: string]: unknown;
        value?: number | null;
      }
        | null;
     total?:   | {
      [key: string]: unknown;
        format?: string;
        formatted_value?: string;
        id: string;
        label: string;
        value?: number | null;
      }
        | null;
   }
     | null;
  interactions_over_time?: unknown;
  link_page_views?:   | {
   [key: string]: unknown;
     value?: number | null;
   }
     | null;
  net_followers_over_time?: unknown;
  profile_visits?:   | {
   [key: string]: unknown;
     value?: number | null;
   }
     | null;
  viewers_or_reach?:   | {
   [key: string]: unknown;
     format?: string;
     formatted_value?: string;
     id: string;
     label: string;
     value?: number | null;
   }
     | null;
  views_over_time?: unknown;
}>;

The account overview for a date range: views, interactions, reach, profile visits.

Parameters ​

ParameterType
clientPrivateClient
range?InsightsRange

Returns ​

Promise<{ [key: string]: unknown; account_views_by_content_type?: | { [key: string]: unknown; entries?: object[]; total?: number | null; } | null; account_views_count?: | { [key: string]: unknown; follow_type_breakdown?: | { [key: string]: unknown; follower?: | { [key: string]: unknown; value?: number | null; } | null; non_follower?: | { [key: string]: unknown; value?: number | null; } | null; } | null; total?: | { [key: string]: unknown; format?: string; formatted_value?: string; id: string; label: string; value?: number | null; } | null; } | null; bio_link_taps?: | { [key: string]: unknown; value?: number | null; } | null; business_address_taps?: | { [key: string]: unknown; value?: number | null; } | null; interactions_by_content_type?: | { [key: string]: unknown; sub_breakdowns?: unknown[]; total_breakdown?: | { [key: string]: unknown; entries?: object[]; total?: number | null; } | null; } | null; interactions_count?: | { [key: string]: unknown; follower?: | { [key: string]: unknown; value?: number | null; } | null; non_follower?: | { [key: string]: unknown; value?: number | null; } | null; total?: | { [key: string]: unknown; format?: string; formatted_value?: string; id: string; label: string; value?: number | null; } | null; } | null; interactions_over_time?: unknown; link_page_views?: | { [key: string]: unknown; value?: number | null; } | null; net_followers_over_time?: unknown; profile_visits?: | { [key: string]: unknown; value?: number | null; } | null; viewers_or_reach?: | { [key: string]: unknown; format?: string; formatted_value?: string; id: string; label: string; value?: number | null; } | null; views_over_time?: unknown; }>

MIT License. Not affiliated with, endorsed or sponsored by Meta or Instagram.