Using the API Access

The Fanpage Karma API access is an interface that allows companies that have their own data stores to query metrics values and posts for specific time periods in a machine-readable format.

This means that they do not need to manually export the data from their dashboard, but can use programs to do so and process the information within their own system.

For Developers

See the detailed guide on how to use the API for developers: https://www.fanpagekarma.com/api/doc

Still have questions? Let us know at service@fanpagekarma.com!

How to use the Fanpage Karma API

You can use the Fanpage Karma API to run two different queries and get either all metric values or all posts including relevant details (text, link, post type, image, KPIs) for a specific profile. 

Use the following URL structure to retrieve your data via our interface:

url structure fanpage karma api

Enter values for each parameter as follows: 

Version 

There is only one version so far  

url structure fanpage karma api version

Platforms

We currently support nine platforms:

Profile ID

Enter the ID of the respective profile to specify your query.

Task

You can choose between the two variants /kpi or /posts, depending on what data you need.

Access Token

You need a valid token for your request, which you can find in your Fanpage Karma account settings in the API section.

url structure fanpage karma api profile token

Period

Add a desired time period. This is optional. If you do not specify the period, you will get the data from the last 28 days. Keep the following format ‘YYYY-MM-DD_YYYY-MM-DD’, e.g. ‘2021-01-01_2021-01-31’.

Start your query

Now enter all the parameters for the URL and start your query. Here is an example for both variants, profiles and posts:

KPI Query

kpi query fanpage karma api

Example: www.fanpagekarma.com/api/v1/facebook/6815841748/kpi?token=abcdefghijklmnopqrstuvwxyz

kpi query fanpage karma api data structure

Post Query

post query fanpage karma query

Example: www.fanpagekarma.com/api/v1/facebook/6815841748/posts?token=abcdefghijklmnopqrstuvwxyz

post query fanpage karma query data structure

Note: API access is available from the Gold version. The cost is 4 Euro per requested profile.

Scroll to Top