Dashboards

Social BI dashboards organize your analytics reports into configurable layouts. Each dashboard contains one or more report widgets that query performance data across your social media activity. Use these endpoints to list available dashboards, retrieve a dashboard with its reports, and execute a specific report query to fetch its data.

Dashboards and reports are created and configured through the Oktopost user interface. These endpoints provide read-only access to existing dashboards and their data.

List Dashboards

Will return a paginated list of dashboards accessible to the authenticated user.

Parameters

Param	Default	Description
_page	0	Current page
_count	25	Results per page
_order	created,0	Sort field and direction. Options: name, description, visibility, createdBy, creatorName, createdOn. 0 means descending and 1 means ascending
search	-	Filter by dashboard name (substring match)
visibility	-	Options: shared, private

Example Request

curl -i https://api.oktopost.com/v2/dashboard

Example Response

{
	"Result": true,
	"Items": [
		{
			"Id": "a1b2c3d4e5",
			"Name": "Monthly Overview",
			"Description": "Key metrics across all campaigns",
			"Visibility": "shared",
			"CreatedBy": "001XXXXXXXXXXXX",
			"Created": "2025-09-15 10:30:00",
			"IsFavorite": true,
			"CreatorName": "Jane Smith",
			"LinkSharingVisibility": "none"
		}
	],
	"Total": 12,
	"TotalUnfiltered": 24
}

Get Dashboard

Will return a single dashboard by ID, including its list of report widgets.

Example Request

curl -i https://api.oktopost.com/v2/dashboard/a1b2c3d4e5

Example Response

{
	"Result": true,
	"Dashboard": {
		"Id": "a1b2c3d4e5",
		"Name": "Monthly Overview",
		"Description": "Key metrics across all campaigns",
		"Type": "custom",
		"Visibility": "shared",
		"Widgets": [
			{
				"Id": "w1x2y3z4",
				"Type": "report",
				"Name": "Post Engagement",
				"Description": "Engagement metrics by network",
				"ChartType": "bar",
				"Source": "post",
				"X": 0,
				"Y": 0,
				"Width": 6,
				"Height": 4
			},
			{
				"Id": "w5x6y7z8",
				"Type": "report",
				"Name": "Click Performance",
				"Description": "Click-through rates over time",
				"ChartType": "line",
				"Source": "click",
				"X": 6,
				"Y": 0,
				"Width": 6,
				"Height": 4
			}
		],
		"Teams": []
	}
}

Get Dashboard Report Data

Will execute a report widget query and return the analytics data. This returns the computed query results for a specific report within a dashboard, not the report configuration.

The report is executed using the dashboard's date range and filters. You can pass additional filters via the filter parameter.

Parameters

Param	Default	Description
id	(required)	The widget/report ID to query. Must be a report widget that belongs to the dashboard.
filter	-	Additional filter criteria (JSON object)

Example Request

curl -i "https://api.oktopost.com/v2/dashboard/a1b2c3d4e5/report?id=w1x2y3z4"

Example Response

{
	"Result": true,
	"Data": [
		{
			"Network": "LinkedIn",
			"Impressions": 15200,
			"Engagements": 843,
			"Clicks": 312
		},
		{
			"Network": "Twitter",
			"Impressions": 8700,
			"Engagements": 421,
			"Clicks": 198
		}
	],
	"Entities": {}
}

On this page