{"id":19399762,"url":"https://github.com/fbsamples/insights_dashboard","last_synced_at":"2025-04-24T06:32:17.629Z","repository":{"id":67475815,"uuid":"554370153","full_name":"fbsamples/insights_dashboard","owner":"fbsamples","description":"Insights Dashboard is a sample app that integrates with Meta's Insights APIs","archived":false,"fork":false,"pushed_at":"2023-10-13T09:23:48.000Z","size":1976,"stargazers_count":8,"open_issues_count":0,"forks_count":4,"subscribers_count":8,"default_branch":"main","last_synced_at":"2024-04-09T22:10:10.142Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fbsamples.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2022-10-19T17:44:28.000Z","updated_at":"2024-01-24T22:13:45.000Z","dependencies_parsed_at":"2023-10-02T03:51:00.647Z","dependency_job_id":null,"html_url":"https://github.com/fbsamples/insights_dashboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbsamples%2Finsights_dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbsamples%2Finsights_dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbsamples%2Finsights_dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fbsamples%2Finsights_dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fbsamples","download_url":"https://codeload.github.com/fbsamples/insights_dashboard/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223942581,"owners_count":17229112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-10T11:11:07.821Z","updated_at":"2024-11-10T11:11:08.289Z","avatar_url":"https://github.com/fbsamples.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/fbsamples/insights_dashboard\"\u003e\n    \u003cimg src=\"images/logo.png\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eMeta Insights API Dashboard\u003c/h3\u003e\n\n  \u003cp align=\"center\"\u003e\n    A sample dashboard to jumpstart your Meta Insights API projects!\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003ca href=\"https://github.com/fbsamples/insights_dashboard/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/fbsamples/insights_dashboard/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\u003c!-- TABLE OF CONTENTS --\u003e\n\u003cdetails\u003e\n  \u003csummary\u003eTable of Contents\u003c/summary\u003e\n  \u003col\u003e\n    \u003cli\u003e\n      \u003ca href=\"#about-the-project\"\u003eAbout The Project\u003c/a\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\n      \u003ca href=\"#getting-started\"\u003eGetting Started\u003c/a\u003e\n      \u003cul\u003e\n        \u003cli\u003e\u003ca href=\"#prerequisites\"\u003ePrerequisites\u003c/a\u003e\u003c/li\u003e\n        \u003cli\u003e\u003ca href=\"#installation\"\u003eInstallation\u003c/a\u003e\u003c/li\u003e\n      \u003c/ul\u003e\n    \u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#usage\"\u003eUsage\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#contributing\"\u003eContributing\u003c/a\u003e\u003c/li\u003e\n    \u003cli\u003e\u003ca href=\"#license\"\u003eLicense\u003c/a\u003e\u003c/li\u003e\n  \u003c/ol\u003e\n\u003c/details\u003e\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nThis project showcases sample API usage for multiple Meta Insights API products, in a friendly easy-to-use dashboard.\n\n* For your reference the documentation of Meta Insights APIs used in this project are:\n\n    - [Ads Insights API](https://developers.facebook.com/docs/marketing-api/insights/)\n    - [Whatsapp Template Analytics API](https://developers.facebook.com/docs/whatsapp/business-management-api/analytics/)\n    - [Page Insights API](https://developers.facebook.com/docs/platforminsights/page)\n    - [Video Insights API](https://developers.facebook.com/docs/video-api/guides/insights/)\n    - [Instagram Insights API](https://developers.facebook.com/docs/instagram-api/guides/insights)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n* In order to run the Insights Dashboard app, you will need to update the configuration file by adding the:\n\n    - [Ad Account ID and User Access Token](https://developers.facebook.com/docs/facebook-login/guides/access-tokens/)\n    - [Facebook Page ID and Access Token](https://developers.facebook.com/docs/pages/access-tokens)\n    - [Instagram User ID and Access Token](https://developers.facebook.com/docs/instagram-api/getting-started)\n\n### Prerequisites\n\n* If running locally:\n    * [nodeJS](https://nodejs.org/en/download/), which you can install via Homebrew (MacOS only)  - `brew install node`\n    * [yarn](https://classic.yarnpkg.com/lang/en/docs/install), which you can install via Homebrew (MacOS only) - `brew install yarn`\n* If running in dev container:\n    * [Docker](https://www.docker.com/) or another environment that supports dev containers e.g. [GitHub Codespaces](https://github.com/features/codespaces).\n\n* 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](https://developers.facebook.com/docs/development/) to create your app first.\n\n\n### Installation\n\n1. Run `npm install` or `yarn install`\n\n    Installs project dependencies.\n    Open the terminal and run `npm install` or `yarn install`.\n\n2. Set up `.env.local` file\n\n    Copy the file `.sample.env.local` to `.env.local`\n\n    ```\n    cp .sample.env.local .env.local\n    ```\n\n    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.\n\n\n## Usage\n1. Run `npm run dev` or `yarn dev`\n\n   Runs the app in the development mode. Open [http://localhost:3000](http://localhost:3000) to view it in your browser.\n\n    The page will reload when you make changes. You may also see any errors in the console.\n\n2. Run `npm run build` or `yarn build`\n    Builds the app for production to the `build` folder.\nIt correctly bundles React in production mode and optimizes the build for the best performance.\n\n3. Run `npm run cypress` or `yarn cypress`\n\n    Launches the test runner with Cypress in the interactive watch mode.\n\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are **greatly appreciated**.\n\nIf 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\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the Meta Platform Policy. See `LICENSE` file for more information.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbsamples%2Finsights_dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffbsamples%2Finsights_dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffbsamples%2Finsights_dashboard/lists"}