Implementing the Reporting API for Later Influence

It simplifies the integration of campaign metrics into third-party reporting dashboards and analytical tools like Looker, Microsoft BI, Oracle Analytics Cloud, SAP Analytics Cloud, Tableau, and more. Synthesizing Later Influence data alongside other data sources allows custom reporting for deeper analysis and more informed decision-making.

Note: A developer on your team will need to enable this functionality.

In this article:

Authentication
Usage & Examples
Reporting Options
API Documentation

Authentication

Authentication for accessing these routes is handled by JWT (JSON Web Tokens), where clients must exchange their clientId and clientSecret for a token.

Please contact your Account Manager to get your clientId and clientSecret. Your developer will set up API calls using these credentials to import the relevant data into your third-party tool.

Usage & Examples

The Reporting API provides the following 5 routes:

Important: All routes now require the v1/reporting-api prefix.

/oauth/token Route

The /oauth/token route retrieves a JWT based on the clientId and clientSecret.

Example cURL Request & Response

cURL:

curl --request POST \
  --url 'https://api.mavrck.co/oauth/token' \
  --header 'Content-Type: application/json' \
  --header 'accept: application/json' \
  --data '{
  "clientId": "",
  "clientSecret": ""
}'

Response:

{
	"jwt": "eyJhbGciOiJSUzI1NiJ9.eyJzY29wZSI6InJlYWQ6cmVwb3J0cyIsInN1YiI6InRlY2giLCJpYXQiOjE3MDc5MDI5NjAsImV4cCI6MTcwNzk0NjE2MH0.GoeA7wi5KVwH9FiVGjUc2cskeevxKVirnVqXUV5P-EyNxc3Kx4tlO9nqGQ8EvnHDMzCklxLc0hKe9CpsI5VTEksucQEd4WmrCJ6spYt1zQ3OIPxYLzmexSBNDJEX8WmAhQFsWBMfWIZd8bYRoH_EjB1oxII7CQ7Xv6_wik0VJn6su5CH24Hl6QEkSb4o1tBqAdg1ia77XKBjZSjtsA-Tn8leTHLQgSOe-Eg4dNhC8yBbT6mkdsyW58ly_uAOUdTQVWPBiN4CUXkifZFGxdmJSk69Gr4T3A4u_PAVpRvgs1xqZhtuWbk_jvIDUffeh5l_G2hOi_BiOWDTHQCU-Tie2g"
}

/instance Route

The /instance route fetches information about instances linked to the supplied credentials.

Example cURL Request & Response

cURL:

curl --request GET \
  --url https://api.mavrck.co/v1/reporting-api/instance \
  --header 'Authorization: Bearer ' \

Response:

[
  {
    "id": 1974,
    "keyname": "dev03",
    "name": "dev03",
    "tagline": "A tagline for test instance",
    "description": "Description set for testing purposes"
  }
]

/campaign Route

The /campaign route retrieves campaigns associated with the community linked to the supplied credentials. It also allows filtering results by campaign ID.

Example cURL Request & Response

cURL:

curl --request GET \
  --url 'https://api.mavrck.co/v1/reporting-api/campaign?campaignId=3' \
  --header 'Authorization: Bearer ' \

Response:

[
  {
    "id": 49759,
    "instance_id": 1974,
    "start_date": "2023-06-05T14:39:00.000Z",
    "end_date": null,
    "status": "LIVE",
    "title": "Test campaign 1",
    "description": "Campaign description"
  },
]

/reporting-group Route

The /reporting-group route provides information about reporting groups, allowing filtering by reporting group ID and campaign ID.

Example cURL Request & Response

cURL:

	curl --request GET \
  --url 'https://api.mavrck.co/v1/reporting-api/reporting-group?reportingGroupId=2' \
  --header 'Authorization: Bearer ' \

Response:

[
  {
    "id": 49759,
    "campaign_id": 9377,
    "start_date": "2023-06-05T14:39:00.000Z",
    "end_date": null,
    "status": "LIVE",
    "description": "Connect your accounts below to complete your application.",
    "title": "Test 1"
  }
]

/report Route

The /report route retrieves content metrics reports, allowing various filtering options such as grouping by date, specifying start and end dates, and filtering by campaign ID and reporting group ID.

Tip: The report route now includes additional affiliate data such as clicks, conversions, and conversion value.

Example cURL Request & Response

cURL:

curl --request GET \
  --url 'https://api.mavrck.co/v1/reporting-api/report?groupBy=YEAR&fromDate=2024-01-01&campaignId=3' \
  --header 'Authorization: Bearer ' \

Response:

{
	"data": [
		{
			"dateGroup": "2024",
			"total_content": 0,
			"content_activated_members": 0,
			"likes": 0,
			"comments": 0,
			"shares": 0,
			"total_impressions": 0,
			"total_engagements": 0,
			"content_reach": 0,
			"facebook": {
				"total_number_of_engagements": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_reel_engagements": 0,
				"total_number_of_impressions": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_reel_impressions": 0,
				"total_content": 0,
				"post_content": 0,
				"live_content": 0,
				"reel_content": 0,
				"number_of_story_engagements": 0,
				"number_of_story_impressions": 0,
				"story_content": 0
			},
			"instagram": {
				"total_number_of_engagements": 0,
				"number_of_post_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"total_number_of_impressions": 0,
				"number_of_post_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"total_content": 0,
				"post_content": 0,
				"story_content": 0,
				"reel_content": 0,
				"number_of_live_engagements": 0,
				"number_of_live_impressions": 0,
				"live_content": 0
			},
			"twitter": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"pinterest": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"blog": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"youtube": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"snapchat": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"tiktok": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"linkedin": {
				"total_number_of_engagements": 0,
				"total_number_of_impressions": 0,
				"total_content": 0,
				"number_of_post_engagements": 0,
				"number_of_live_engagements": 0,
				"number_of_story_engagements": 0,
				"number_of_reel_engagements": 0,
				"number_of_post_impressions": 0,
				"number_of_live_impressions": 0,
				"number_of_story_impressions": 0,
				"number_of_reel_impressions": 0,
				"post_content": 0,
				"live_content": 0,
				"story_content": 0,
				"reel_content": 0
			},
			"non_network_content": 0,
			"non_network_images_uploaded": 0,
			"non_network_videos_uploaded": 0,
			"member_registrations": 0,
			"activations": 0,
			"activated_members": 0,
			"surveys": 0,
			"reviews": 0,
			"clicks": 0,
			"conversions": 0,
			"conversions_value": 0
		}
	]
}

Reporting Options

Enter a relevant date range by inputting a start and end date in the API call. Data can be grouped by year, quarter, month, week (starting Monday), week (starting Sunday), or day using the "groupBy" field.

Report on either a campaign or a reporting group by setting the campaign ID or reporting group ID in the API call.

The API will return all metrics, including content totals, impressions, and engagements by network type.

Once a campaign or reporting group ID and a date range have been set, the API will return totaled raw data.

Further grouping and manipulation of data can be achieved in your third-party tool.

API Documentation

The Reporting API is documented in Swaggerhub here.

Search

Hi, how can we help?

In this Article:

Authentication

Usage & Examples

/oauth/token Route

/instance Route

/campaign Route

/reporting-group Route

/report Route

Reporting Options

API Documentation