Meta Insights API Dashboard

A sample dashboard to jumpstart your Meta Insights API projects!


Report Bug · Request Feature

Table of Contents

1. About The Project
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License

About The Project

This project showcases sample API usage for multiple Meta Insights API products, in a friendly easy-to-use dashboard.

• For your reference the documentation of Meta Insights APIs used in this project are:

  • Ads Insights API
  • Whatsapp Template Analytics API
  • Page Insights API
  • Video Insights API
  • Instagram Insights API

(back to top)

Getting Started

• In order to run the Insights Dashboard app, you will need to update the configuration file by adding the:

  • Ad Account ID and User Access Token
  • Facebook Page ID and Access Token
  • Instagram User ID and Access Token

Prerequisites

• If running locally:

  • nodeJS, which you can install via Homebrew (MacOS only) - brew install node
  • yarn, which you can install via Homebrew (MacOS only) - brew install yarn

• If running in dev container:

  • Docker or another environment that supports dev containers e.g. GitHub Codespaces.

• You will need to have a Facebook Page / Ad account and an App created in Meta Developers. If you don’t have an app, follow the guide here to create your app first.

Installation

1. Run npm install or yarn install

   Installs project dependencies. Open the terminal and run npm install or yarn install.

2. Set up .env.local file

   Copy the file .sample.env.local to .env.local

   cp .sample.env.local .env.local
   

   Edit the .env.local file to add all the values for your project including your Meta information related to Pages, Instagram and Ad Account to fetch the Insights data.

Usage

1. Run npm run dev or yarn dev

   Runs the app in the development mode. Open http://localhost:3000 to view it in your browser.

   The page will reload when you make changes. You may also see any errors in the console.

2. Run npm run build or yarn build Builds the app for production to the build folder. It correctly bundles React in production mode and optimizes the build for the best performance.

3. Run npm run cypress or yarn cypress

   Launches the test runner with Cypress in the interactive watch mode.

(back to top)

Contributing

Contributions are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the Meta Platform Policy. See LICENSE file for more information.

(back to top)