Use of API Access (Application Programming Interface)

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 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.

How to use the Fanpage Karma API

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

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

url structure fanpage karma api

Enter values for the individual parameters as follows: 

VERSION 

There is only one version so far  

url structure fanpage karma api version

NETWORK

We currently support seven networks:

url structure fanpage karma api network

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 which data you require.

TOKEN

For your query, you need a valid token, which you can find in the settings of your Fanpage Karma account in the API section.

url structure fanpage karma api profile token

PERIOD

Add a desired period of time. 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 to the URL and start your query. Here you can find an example for both variants, profiles or posts, as follows: 

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

Hint: The API access is available as of the Gold version. The cost is 4 euros per queried profile.

For Developers

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

Do you have any questions? Let us know at service@fanpagekarma.com!

14-day free trial

Take the chance and put Fanpage Karma through its paces.

We are here for you!

Do you have questions or problems? Drop us a message at service@fanpagekarma.com. We will get back to you as soon as possible.

14-day free trial

Take the chance and put Fanpage Karma through its paces.