Data Profiling

Create profile result

post

Creates or updates a profile result for the specified data structure.

Path parameters

data_structure_idintegerRequired

Data structure ID

Body

application/json

Responses

201

Profile created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/data_structures/{data_structure_id}/profile_results

HTTPcURLJavaScriptPython

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
      }
    }
  }
}

Show profile execution group

get

Retrieves a profile execution group by ID and returns only executions visible to the current user.

Path parameters

idintegerRequired

Profile execution group ID

Responses

200

Profile execution group details

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/profile_execution_groups/{id}

HTTPcURLJavaScriptPython

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"
  }
}

List profile executions

get

Retrieves profile executions filtered by query parameters and scoped to the current user's permissions.

Query parameters

profile_group_idintegerOptional

Filter by profile execution group ID

execution_group_idintegerOptional

Alias for profile_group_id filter

statusstring · enumOptional

Filter pending executions without profile or events

Possible values:

sourcestringOptional

Filter by data source external ID

sourcesstring[]Optional

Filter by multiple data source external IDs

Responses

200

Profile executions

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/profile_executions

HTTPcURLJavaScriptPython

GET /api/profile_executions HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": 123,
      "inserted_at": "2026-05-07T12:34:56Z"
    }
  ]
}

Upload profiling data

post

Uploads profiling data via multipart form and returns an accepted response.

Body

multipart/form-data

profilingstring · binaryRequired

CSV file with profiling data

Responses

202

Profile upload accepted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/profiles/upload

HTTPcURLJavaScriptPython

POST /api/profiles/upload HTTP/1.1
Content-Type: multipart/form-data
Accept: */*
Content-Length: 29

{
  "profiling": "<binary file>"
}

No content

Search profile executions

post

Searches profile execution records using the given search parameters and returns matching executions.

Body

application/json

execution_group_idinteger · nullableOptional

Alias for profile_group_id filter

profile_group_idinteger · nullableOptional

Filter by profile execution group ID

sourcestring · nullableOptional

Filter by data source external ID

sourcesstring[] · nullableOptional

Filter by multiple data source external IDs

statusstring · enum · nullableOptional

Filter executions without profile or events

Possible values:

Responses

200

Profile executions search results

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

post/api/profile_executions/search

HTTPcURLJavaScriptPython

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"
    }
  ]
}

Search profiles

post

Searches profiles matching the provided criteria and returns matching results.

Body

application/json

limitintegerOptional

Maximum number of profiles to return

offsetintegerOptional

Number of profiles to skip

sincestringOptional

Return profiles updated at or after this timestamp (ISO 8601)

Responses

200

Search results

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/profiles/search

HTTPcURLJavaScriptPython

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
        }
      }
    }
  ]
}

Create profile event

post

Creates a new profile event for the given profile execution.

Path parameters

profile_execution_idintegerRequired

Profile execution ID

Body

application/json

Responses

201

Profile event

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/profile_executions/{profile_execution_id}/profile_events

HTTPcURLJavaScriptPython

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"
  }
}

Show profile execution

get

Retrieves a specific profile execution by ID, including its profile and associated events.

Path parameters

idintegerRequired

Profile execution ID

Responses

200

Profile execution

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

500

Internal Server Error

application/json

get/api/profile_executions/{id}

HTTPcURLJavaScriptPython

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"
  }
}

List profile execution groups

get

Returns profile execution groups visible to the current user.

Responses

200

List profile execution groups

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

500

Internal Server Error

application/json

get/api/profile_execution_groups

HTTPcURLJavaScriptPython

GET /api/profile_execution_groups HTTP/1.1
Accept: */*

{
  "data": [
    {
      "id": 123,
      "inserted_at": "2026-05-07T12:34:56Z"
    }
  ]
}

Create profile execution group

post

Creates a new profile execution group from the provided payload and returns the created record.

Body

application/json

data_structure_idsinteger[] · min: 1Optional

Data structure IDs to profile. At least one of this or parent_structure_id must be provided.

parent_structure_idintegerOptional

Parent data structure ID. Creates executions for all visible child fields. At least one of this or data_structure_ids must be provided.

Responses

201

Profile execution group created

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

422

Unprocessable Entity

application/json

500

Internal Server Error

application/json

post/api/profile_execution_groups

HTTPcURLJavaScriptPython

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"
  }
}