Portal Data API

Programmatic access to engagement data from the Client Reporting Dashboard

Interactive Docs (Swagger) API Reference (ReDoc)

Authentication

All endpoints (except /health) require an API key in the X-API-Key header.

curl -H "X-API-Key: your-api-key" https://portal-api.asperasalesagency.fi/stats

API Key Types:
• Admin - Full access to all data, can filter by any client
• Client - Access restricted to that client's data only

Endpoints

GET /engagements

List engagements with filtering and pagination.

Query Parameters

Parameter	Type	Default	Description
`date_from`	date	30 days ago	Start date (YYYY-MM-DD)
`date_to`	date	today	End date (YYYY-MM-DD)
`search`	string	-	Search in company, name, email, comment
`status`	string	-	Filter by status (Dialogi, Onnistuminen, etc.)
`company`	string	-	Filter by company name (partial match)
`page`	int	1	Page number
`size`	int	50	Results per page (max 1000)
`client`	string	-	Admin only: filter by client name

Example

curl -H "X-API-Key: $API_KEY" \
  "https://portal-api.asperasalesagency.fi/engagements?date_from=2026-01-01&status=Onnistuminen&size=10"

GET /stats

Get engagement statistics (same calculations as the dashboard).

Query Parameters

Parameter	Type	Default	Description
`date_from`	date	30 days ago	Start date (YYYY-MM-DD)
`date_to`	date	today	End date (YYYY-MM-DD)
`client`	string	-	Admin only: filter by client name

Response

{
  "status_distribution": {"Dialogi": 95, "Onnistuminen": 32, "Vastaaja": 120},
  "dialogues_count": 127,
  "success_count": 32,
  "total_engagements": 247,
  "date_range": {"from": "2026-01-01", "to": "2026-01-31"}
}

GET /health

Health check (no authentication required).

curl https://portal-api.asperasalesagency.fi/health

Status Values

Status	Description
`Onnistuminen`	Success - meeting booked or deal created
`Dialogi`	Dialogue - meaningful conversation
`Vastaaja`	Voicemail
`Ei vastaa`	No answer
`Kieltäytyi`	Declined

Error Codes

Code	Description
401	Missing or invalid API key
403	Access denied (e.g., client key accessing other client's data)
404	Resource not found

Portal Data API v1.0.0 • Contact Support