Analytics API (1.0.0)

Download OpenAPI specification:

This documentation describes the Analytics Data API of the Haiilo Intranet.

Authentication

User Activity

User Activity Dashboard

user_activity_adoption

user_activity_adoption This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

user_activity_active_users

user_activity_active_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_interacting_users

user_activity_interacting_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_creating_users

user_activity_creating_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_avg_session_length

user_activity_avg_session_length This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_visits

user_activity_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_web_visits

user_activity_web_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_ios_visits

user_activity_ios_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_android_visits

user_activity_android_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_web_mobile_visits

user_activity_web_mobile_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_other_clients_visits

user_activity_other_clients_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_web_active_users

user_activity_web_active_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_ios_active_users

user_activity_ios_active_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_android_active_users

user_activity_android_active_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_web_mobile_active_users

user_activity_web_mobile_active_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_other_clients_active_users

user_activity_other_clients_active_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_web_avg_session_length

user_activity_web_avg_session_length This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_ios_avg_session_length

user_activity_ios_avg_session_length This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_android_avg_session_length

user_activity_android_avg_session_length This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_web_mobile_avg_session_length

user_activity_web_mobile_avg_session_length This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_other_clients_avg_session_length

user_activity_other_clients_avg_session_length This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

Content

Content Dashboard

content_created_content_timeline_items

content_created_content_timeline_items This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_created_content_blog_articles

content_created_content_blog_articles This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_created_content_wiki_articles

content_created_content_wiki_articles This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_interactions_comments

content_interactions_comments This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_interactions_likes

content_interactions_likes This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_interactions_shares

content_interactions_shares This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_content_performance

content_content_performance This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"contentId": "01234567-89ab-cdef-0123-456789abcdef",
"creationTime": "Mon Jan 27 2025 11:00:00 GMT+0000 (GMT)",
"type": "timeline-item",
"link": "/timeline/item/01234567-89ab-cdef-0123-456789abcdef",
"title": "Hi everyone,\nthis is a test post.",
"senderName": "News",
"impressions": 200,
"reach": 150,
"views": 100,
"uniqueViews": 50,
"likes": 30,
"comments": 5,
"shares": 2,
"sentiment": 0.64,
"engagementRate": 50
}
]

Pages

Pages Dashboard

pages

pages This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

pages_list

pages_list This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"senderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "News",
"creationTime": "2025-01-01T00:00:00.000Z",
"status": "ACTIVE",
"admin": true,
"visits": 1000,
"visitors": 500
}
]

pages_details

pages_details This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

user_activity_pages_users_viewing_users

user_activity_pages_users_viewing_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_users_interacting_users

user_activity_pages_users_interacting_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_users_creating_users

user_activity_pages_users_creating_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_avg_usage_duration

user_activity_pages_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_visits

user_activity_pages_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_visitors

user_activity_pages_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_web_avg_usage_duration

user_activity_pages_web_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_ios_avg_usage_duration

user_activity_pages_ios_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_android_avg_usage_duration

user_activity_pages_android_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_web_mobile_avg_usage_duration

user_activity_pages_web_mobile_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_other_clients_avg_usage_duration

user_activity_pages_other_clients_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_web_visits

user_activity_pages_web_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_ios_visits

user_activity_pages_ios_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_android_visits

user_activity_pages_android_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_web_mobile_visits

user_activity_pages_web_mobile_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_other_clients_visits

user_activity_pages_other_clients_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_web_visitors

user_activity_pages_web_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_ios_visitors

user_activity_pages_ios_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_android_visitors

user_activity_pages_android_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_web_mobile_visitors

user_activity_pages_web_mobile_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_pages_other_clients_visitors

user_activity_pages_other_clients_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_created_content_blog_articles

content_pages_created_content_blog_articles This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_created_content_timeline_items

content_pages_created_content_timeline_items This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_created_content_wiki_articles

content_pages_created_content_wiki_articles This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_impacts_impressions

content_pages_impacts_impressions This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_impacts_reach

content_pages_impacts_reach This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_impacts_views

content_pages_impacts_views This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_impacts_unique_views

content_pages_impacts_unique_views This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_interactions_comments

content_pages_interactions_comments This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_interactions_likes

content_pages_interactions_likes This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_interactions_shares

content_pages_interactions_shares This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_pages_content_performance

content_pages_content_performance This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"contentId": "01234567-89ab-cdef-0123-456789abcdef",
"creationTime": "Mon Jan 27 2025 11:00:00 GMT+0000 (GMT)",
"type": "timeline-item",
"link": "/timeline/item/01234567-89ab-cdef-0123-456789abcdef",
"title": "Hi everyone,\nthis is a test post.",
"senderName": "News",
"impressions": 200,
"reach": 150,
"views": 100,
"uniqueViews": 50,
"likes": 30,
"comments": 5,
"shares": 2,
"sentiment": 0.64,
"engagementRate": 50
}
]

apps_pages

apps_pages This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"title": "App Name",
"type": "content",
"active": true,
"visits": 1000,
"visitors": 500,
"avgDailyUsage": 2.5
}
]

Communities

Communities Dashboard

communities

communities This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

communities_list

communities_list This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"senderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "News",
"creationTime": "2025-01-01T00:00:00.000Z",
"status": "ACTIVE",
"admin": true,
"visits": 1000,
"visitors": 500
}
]

communities_details

communities_details This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

user_activity_communities_visits

user_activity_communities_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_visitors

user_activity_communities_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_users_viewing_users

user_activity_communities_users_viewing_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_users_interacting_users

user_activity_communities_users_interacting_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_users_creating_users

user_activity_communities_users_creating_users This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_avg_usage_duration

user_activity_communities_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_web_avg_usage_duration

user_activity_communities_web_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_ios_avg_usage_duration

user_activity_communities_ios_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_android_avg_usage_duration

user_activity_communities_android_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_web_mobile_avg_usage_duration

user_activity_communities_web_mobile_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_other_clients_avg_usage_duration

user_activity_communities_other_clients_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_web_visits

user_activity_communities_web_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_ios_visits

user_activity_communities_ios_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_android_visits

user_activity_communities_android_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_web_mobile_visits

user_activity_communities_web_mobile_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_other_clients_visits

user_activity_communities_other_clients_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_web_visitors

user_activity_communities_web_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_ios_visitors

user_activity_communities_ios_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_android_visitors

user_activity_communities_android_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_web_mobile_visitors

user_activity_communities_web_mobile_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

user_activity_communities_other_clients_visitors

user_activity_communities_other_clients_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_created_content_blog_articles

content_communities_created_content_blog_articles This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_created_content_timeline_items

content_communities_created_content_timeline_items This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_created_content_wiki_articles

content_communities_created_content_wiki_articles This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_impacts_impressions

content_communities_impacts_impressions This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_impacts_reach

content_communities_impacts_reach This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_impacts_views

content_communities_impacts_views This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_impacts_unique_views

content_communities_impacts_unique_views This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_interactions_comments

content_communities_interactions_comments This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_interactions_likes

content_communities_interactions_likes This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_interactions_shares

content_communities_interactions_shares This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_communities_content_performance

content_communities_content_performance This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"contentId": "01234567-89ab-cdef-0123-456789abcdef",
"creationTime": "Mon Jan 27 2025 11:00:00 GMT+0000 (GMT)",
"type": "timeline-item",
"link": "/timeline/item/01234567-89ab-cdef-0123-456789abcdef",
"title": "Hi everyone,\nthis is a test post.",
"senderName": "News",
"impressions": 200,
"reach": 150,
"views": 100,
"uniqueViews": 50,
"likes": 30,
"comments": 5,
"shares": 2,
"sentiment": 0.64,
"engagementRate": 50
}
]

apps_communities

apps_communities This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"title": "App Name",
"type": "content",
"active": true,
"visits": 1000,
"visitors": 500,
"avgDailyUsage": 2.5
}
]

Search

Search Dashboard

search_phrases

search_phrases This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": [{"value1": "id",
"value2": 10
}
]
}

Content Details

content_details

content_details This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

content_details_impacts_impressions

content_details_impacts_impressions This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_impacts_reach

content_details_impacts_reach This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_impacts_views

content_details_impacts_views This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_impacts_unique_views

content_details_impacts_unique_views This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_interactions_comments

content_details_interactions_comments This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_interactions_likes

content_details_interactions_likes This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_interactions_shares

content_details_interactions_shares This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

content_details_social_reactions

content_details_social_reactions This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": [{"name": "positve",
"value": 10
}
]
}

content_details_sentiments

content_details_sentiments This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesContent) Attributes for the KPI. Has to be provided if the KPI is for a single content piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"contentId": "123e4567-e89b-12d3-a456-426614174001"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": [{"name": "positve",
"value": 10
}
]
}

Homepages

homepages

homepages This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

homepages_list

homepages_list This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

object (kpiRequestFilters)

Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

[{"senderId": "123e4567-e89b-12d3-a456-426614174000",
"name": "News",
"creationTime": "2025-01-01T00:00:00.000Z",
"visits": 1000,
"visitors": 500
}
]

homepages_details

homepages_details This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"kpis": [{"name": "views",
"value": 100
}
],
"metadata": [{"name": "title",
"value": "Title of a blog article"
},
{"name": "publicationDate",
"value": "2025-01-01T00:00:00Z"
}
]
}

homepages_avg_usage_duration

homepages_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_visits

homepages_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_visitors

homepages_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_web_avg_usage_duration

homepages_web_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_ios_avg_usage_duration

homepages_ios_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_android_avg_usage_duration

homepages_android_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_web_mobile_avg_usage_duration

homepages_web_mobile_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_other_clients_avg_usage_duration

homepages_other_clients_avg_usage_duration This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_web_visits

homepages_web_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_ios_visits

homepages_ios_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_android_visits

homepages_android_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_web_mobile_visits

homepages_web_mobile_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_other_clients_visits

homepages_other_clients_visits This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_web_visitors

homepages_web_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_ios_visitors

homepages_ios_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_android_visitors

homepages_android_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_web_mobile_visitors

homepages_web_mobile_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

homepages_other_clients_visitors

homepages_other_clients_visitors This endpoint returns the KPI data for the specified kpi.

Request Body schema: application_json
required

	object (kpiRequestAttributesSender) Attributes for the KPI. Has to be provided if the KPI is for a single page/community/landing page piece.
	object (kpiRequestFilters) Filters for the KPI

Responses

Request samples

Payload

Content type

application_json

{"attributes": {"senderId": "123e4567-e89b-12d3-a456-426614174000"
},
"filters": {"dateStart": "2019-08-24",
"dateRange": "days_7",
"profileFields": [{"name": "company",
"values": ["Hamburg",
"Berlin",
"Company A GmbH"
]
}
]
}
}

Response samples

200

Content type

application_json

{"data": {"total": 100,
"previousTotal": 90,
"trendPercent": -10,
"entries": [1,
2,
3,
4,
5,
6,
7
]
}
}

Analytics API (1.0.0)

User Activity

user_activity_adoption

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_active_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_interacting_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_creating_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_avg_session_length

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_visits

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_web_visits

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_ios_visits

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_android_visits

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_web_mobile_visits

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_other_clients_visits

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_web_active_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_ios_active_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_android_active_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_web_mobile_active_users

Request Body schema: application_jsonrequired

Responses

Request samples

Response samples

user_activity_other_clients_active_users

Request Body schema: application_jsonrequired

Responses

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required

Request Body schema: application_json
required