API documentation

API consists of two main modules: analysis module and notebook module. Here you can see the full documentation of API methods and functions.

FacebookPostsAnalysis.analysis module

FacebookPostsAnalysis.analysis.build_token(app_id, app_secret)

Build a Facebook access token from your APP ID and APP SECRET.

Parameters:
  • app_id – Your Facebook APP ID
  • app_secret – Your Facebook APP SECRET
FacebookPostsAnalysis.analysis.build_url_group(group_id, access_token, since_date, until_date, paging)

Build url of a Facebook group.

Parameters:
  • group_id – ID of Facebook group
  • access_token – Your Facebook access token
  • since_date – Date since when to analyse Facebook posts
  • until_date – Date until when to analyse Facebook posts
  • paging – Paging token
FacebookPostsAnalysis.analysis.build_url_page(page_id, access_token, paging, since_date, until_date)

Build url of a Facebook page.

Parameters:
  • page_id – ID of Facebook page
  • access_token – Your Facebook access token
  • since_date – Date since when to analyse Facebook posts
  • until_date – Date until when to analyse Facebook posts
  • paging – Paging token
FacebookPostsAnalysis.analysis.create_request(url, session)

Create a Facebook request and return the json.

Parameters:
  • url – URL of Facebook group/page
  • session – Facebook session
FacebookPostsAnalysis.analysis.get_reactions(url, session)

Get the count of unique reactions of Facebook post.

Parameters:
  • url – URL of Facebook group/page
  • session – Facebook session
FacebookPostsAnalysis.analysis.main()

Main function to run the cli.

FacebookPostsAnalysis.analysis.print_version(ctx, param, value)

Print version of the app (default click implementation).

Parameters:
  • ctx – Context, which is automatically passed by Click library
  • param – Version parameter
  • value – Version value
FacebookPostsAnalysis.analysis.process_time(start_time)

Format the process time of analysis.

Parameters:start_time – Time when the analysis have started
FacebookPostsAnalysis.analysis.read_config(ctx)

Read the credentials and ID of Facebook group/page from configuration file.

Parameters:ctx – Context, which is automatically passed by Click library

FacebookPostsAnalysis.notebook module

FacebookPostsAnalysis.notebook.create_notebook(entity_id)

Create a Jupyter Notebook, containing the full analysis of Facebook group/page.

Parameters:entity_id – ID of Facebook group/page