Data Profiling
Creates or updates a profile result for the specified data structure.
Data structure ID
Profile created
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
POST /api/data_structures/{data_structure_id}/profile_results HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 64
{
"profile": {
"max": "100",
"min": "1",
"total_count": {
"value": 1000
}
}
}{
"data": {
"data_structure_id": 456,
"id": 123,
"updated_at": "2026-05-07T12:34:56Z",
"value": {
"total_count": {
"value": 1000
}
}
}
}Retrieves a profile execution group by ID and returns only executions visible to the current user.
Profile execution group ID
Profile execution group details
Unauthorized
Forbidden
Not found
Internal Server Error
GET /api/profile_execution_groups/{id} HTTP/1.1
Accept: */*
{
"data": {
"_embedded": {
"executions": [
{
"_embedded": {
"data_structure": {
"external_id": "ds_customer_email",
"id": 1
},
"profile": {
"total_count": {
"value": 1000
}
},
"profile_events": []
},
"id": 456,
"inserted_at": "2026-05-07T12:34:56Z"
}
]
},
"created_by_id": 456,
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z"
}
}Retrieves profile executions filtered by query parameters and scoped to the current user's permissions.
Filter by profile execution group ID
Alias for profile_group_id filter
Filter pending executions without profile or events
Filter by data source external ID
Filter by multiple data source external IDs
Profile executions
Unauthorized
Forbidden
Internal Server Error
GET /api/profile_executions HTTP/1.1
Accept: */*
{
"data": [
{
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z"
}
]
}Uploads profiling data via multipart form and returns an accepted response.
CSV file with profiling data
Profile upload accepted
No content
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
POST /api/profiles/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 29
{
"profiling": "<binary file>"
}No content
Searches profile execution records using the given search parameters and returns matching executions.
Alias for profile_group_id filter
Filter by profile execution group ID
Filter by data source external ID
Filter by multiple data source external IDs
Filter executions without profile or events
Profile executions search results
Unauthorized
Forbidden
Internal Server Error
POST /api/profile_executions/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 36
{
"source": "SYS1",
"status": "pending"
}{
"data": [
{
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z"
}
]
}Searches profiles matching the provided criteria and returns matching results.
Maximum number of profiles to return
Number of profiles to skip
Return profiles updated at or after this timestamp (ISO 8601)
Search results
Unauthorized
Forbidden
Unprocessable Entity
Internal Server Error
POST /api/profiles/search HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 54
{
"limit": 10,
"offset": 0,
"since": "2026-01-01T00:00:00Z"
}{
"data": [
{
"data_structure_id": 456,
"id": 123,
"updated_at": "2026-05-07T12:34:56Z",
"value": {
"total_count": {
"value": 1000
}
}
}
]
}Creates a new profile event for the given profile execution.
Profile execution ID
Profile event
Unauthorized
Forbidden
Not found
Unprocessable Entity
Internal Server Error
POST /api/profile_executions/{profile_execution_id}/profile_events HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 68
{
"profile_event": {
"message": "Profile Uploaded.",
"type": "SUCCEEDED"
}
}{
"data": {
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z",
"message": "Profile Uploaded.",
"profile_execution_id": 456,
"type": "SUCCEEDED"
}
}Retrieves a specific profile execution by ID, including its profile and associated events.
Profile execution ID
Profile execution
Unauthorized
Forbidden
Not found
Internal Server Error
GET /api/profile_executions/{id} HTTP/1.1
Accept: */*
{
"data": {
"_embedded": {
"data_structure": {
"external_id": "ds_customer_email",
"id": 1
},
"profile": {
"total_count": {
"value": 1000
}
},
"profile_events": []
},
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z"
}
}Returns profile execution groups visible to the current user.
List profile execution groups
Unauthorized
Forbidden
Internal Server Error
GET /api/profile_execution_groups HTTP/1.1
Accept: */*
{
"data": [
{
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z"
}
]
}Creates a new profile execution group from the provided payload and returns the created record.
Data structure IDs to profile. At least one of this or parent_structure_id must be provided.
Parent data structure ID. Creates executions for all visible child fields. At least one of this or data_structure_ids must be provided.
Profile execution group created
Unauthorized
Forbidden
Not found
Unprocessable Entity
Internal Server Error
POST /api/profile_execution_groups HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"data_structure_ids": [
1,
2,
3
]
}{
"data": {
"_embedded": {
"executions": [
{
"_embedded": {
"data_structure": {
"external_id": "ds_customer_email",
"id": 1
},
"profile": {
"total_count": {
"value": 1000
}
},
"profile_events": []
},
"id": 456,
"inserted_at": "2026-05-07T12:34:56Z"
}
]
},
"created_by_id": 456,
"id": 123,
"inserted_at": "2026-05-07T12:34:56Z"
}
}Last updated