Skip to main content
GET
/
api
/
document-family-statistics
List Document Family Statistics
curl --request GET \
  --url https://platform.kodexa.ai/api/document-family-statistics \
  --header 'x-api-key: <api-key>'
{
  "content": [
    {
      "changeSequence": 123,
      "createdOn": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "recentExecutions": [
        {
          "assistant": {
            "active": true,
            "assistantRole": "<string>",
            "changeSequence": 123,
            "chatEnabled": true,
            "color": "<string>",
            "createdOn": "2023-11-07T05:31:56Z",
            "deleteLoggingOnSuccess": true,
            "deleted": true,
            "description": "<string>",
            "id": "e4567890-12ab-cdef-3456-789012abcdef",
            "loggingEnabled": true,
            "name": "Invoice Extractor",
            "options": {},
            "priorityHint": 123,
            "project": {
              "changeSequence": 123,
              "color": "#4A90D9",
              "createdOn": "2023-11-07T05:31:56Z",
              "dataFlow": {
                "edges": [
                  {
                    "id": "<string>",
                    "properties": {},
                    "source": "<string>",
                    "target": "<string>"
                  }
                ],
                "nodes": [
                  {
                    "dimensions": {
                      "height": 123,
                      "width": 123
                    },
                    "id": "<string>",
                    "parentId": "<string>",
                    "position": {
                      "x": 123,
                      "y": 123
                    },
                    "properties": {},
                    "type": "<string>"
                  }
                ],
                "viewPort": {
                  "x": 123,
                  "y": 123,
                  "zoom": 123
                }
              },
              "description": "Automated invoice processing pipeline.",
              "documentStatuses": [
                {
                  "changeSequence": 123,
                  "color": "<string>",
                  "createdOn": "2023-11-07T05:31:56Z",
                  "icon": "<string>",
                  "id": "<string>",
                  "slug": "<string>",
                  "status": "<string>",
                  "statusType": "UNRESOLVED",
                  "updatedOn": "2023-11-07T05:31:56Z",
                  "uuid": "<string>"
                }
              ],
              "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
              "memory": {
                "changeSequence": 123,
                "orderedDashboards": [
                  "<string>"
                ],
                "recentFilters": {},
                "recentQueries": {}
              },
              "name": "Invoice Processing",
              "notes": "<string>",
              "options": {
                "dataOptions": [
                  {
                    "aliases": [
                      "<string>"
                    ],
                    "default": {},
                    "description": "<string>",
                    "developerOnly": true,
                    "displayProperties": {},
                    "falseLabel": "<string>",
                    "featureFlag": "<string>",
                    "groupOptions": "<array>",
                    "hint": "<string>",
                    "label": "<string>",
                    "listDescription": "<string>",
                    "listLabel": "<string>",
                    "listType": "<string>",
                    "name": "<string>",
                    "overviewMarkdown": "<string>",
                    "possibleValues": [
                      {
                        "description": "<string>",
                        "label": "<string>",
                        "value": {}
                      }
                    ],
                    "properties": {},
                    "required": true,
                    "showIf": "<string>",
                    "showOnPopup": true,
                    "subType": "<string>",
                    "supportArticle": "<string>",
                    "tabName": "<string>",
                    "type": "<string>"
                  }
                ],
                "dataProperties": {},
                "groupTaxonTypeFeatures": {},
                "options": [
                  {
                    "aliases": [
                      "<string>"
                    ],
                    "default": {},
                    "description": "<string>",
                    "developerOnly": true,
                    "displayProperties": {},
                    "falseLabel": "<string>",
                    "featureFlag": "<string>",
                    "groupOptions": "<array>",
                    "hint": "<string>",
                    "label": "<string>",
                    "listDescription": "<string>",
                    "listLabel": "<string>",
                    "listType": "<string>",
                    "name": "<string>",
                    "overviewMarkdown": "<string>",
                    "possibleValues": [
                      {
                        "description": "<string>",
                        "label": "<string>",
                        "value": {}
                      }
                    ],
                    "properties": {},
                    "required": true,
                    "showIf": "<string>",
                    "showOnPopup": true,
                    "subType": "<string>",
                    "supportArticle": "<string>",
                    "tabName": "<string>",
                    "type": "<string>"
                  }
                ],
                "properties": {},
                "taskOptions": {
                  "showNewTask": true,
                  "showTakeNext": true
                },
                "taxonTypeFeatures": {}
              },
              "organization": {
                "authGroupLink": {
                  "authGroup": "<string>"
                },
                "changeSequence": 123,
                "createdOn": "2023-11-07T05:31:56Z",
                "defaultToPrivateTemplates": true,
                "description": "Document processing organization for Acme Corp.",
                "enterpriseOrganization": true,
                "features": {},
                "hasImage": true,
                "id": "550e8400-e29b-41d4-a716-446655440000",
                "memory": {
                  "orderedDashboards": [
                    "<string>"
                  ]
                },
                "name": "Acme Corp",
                "organizationStatus": "ACTIVE",
                "properties": {},
                "publicAccess": true,
                "searchText": "<string>",
                "slug": "acme-corp",
                "stripeCustomerId": "<string>",
                "supportAccess": true,
                "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "550e8400e29b41d4a716446655440000"
              },
              "organizationId": "<string>",
              "owner": {
                "active": true,
                "bio": "<string>",
                "businessGroup": "<string>",
                "changeSequence": 123,
                "createdOn": "2023-11-07T05:31:56Z",
                "email": "<string>",
                "firstName": "<string>",
                "groupsJson": "<string>",
                "id": "<string>",
                "image": "<string>",
                "isExternallyManaged": true,
                "lastName": "<string>",
                "preferences": {
                  "showOnboarding": true,
                  "showScrollbars": true,
                  "showWelcomeMessage": true
                },
                "roles": {
                  "roles": [
                    "<string>"
                  ]
                },
                "rolesJson": "<string>",
                "searchText": "<string>",
                "showDeveloperTools": true,
                "title": "<string>",
                "updatedOn": "2023-11-07T05:31:56Z",
                "userStorage": {
                  "favoriteLinks": [
                    {
                      "link": "<string>"
                    }
                  ]
                },
                "userType": "<string>",
                "uuid": "<string>"
              },
              "ownerId": "<string>",
              "projectTemplateRef": "<string>",
              "searchText": "<string>",
              "slug": "invoice-processing",
              "status": {
                "changeSequence": 123,
                "color": "<string>",
                "createdOn": "2023-11-07T05:31:56Z",
                "icon": "<string>",
                "id": "<string>",
                "organization": {
                  "authGroupLink": {
                    "authGroup": "<string>"
                  },
                  "changeSequence": 123,
                  "createdOn": "2023-11-07T05:31:56Z",
                  "defaultToPrivateTemplates": true,
                  "description": "Document processing organization for Acme Corp.",
                  "enterpriseOrganization": true,
                  "features": {},
                  "hasImage": true,
                  "id": "550e8400-e29b-41d4-a716-446655440000",
                  "memory": {
                    "orderedDashboards": [
                      "<string>"
                    ]
                  },
                  "name": "Acme Corp",
                  "organizationStatus": "ACTIVE",
                  "properties": {},
                  "publicAccess": true,
                  "searchText": "<string>",
                  "slug": "acme-corp",
                  "stripeCustomerId": "<string>",
                  "supportAccess": true,
                  "supportAccessExpiresAt": "2023-11-07T05:31:56Z",
                  "updatedOn": "2023-11-07T05:31:56Z",
                  "uuid": "550e8400e29b41d4a716446655440000"
                },
                "organizationId": "<string>",
                "production": true,
                "status": "<string>",
                "updatedOn": "2023-11-07T05:31:56Z",
                "uuid": "<string>"
              },
              "statusId": "<string>",
              "statusType": "ACTIVE",
              "taskStatuses": [
                {
                  "changeSequence": 123,
                  "color": "<string>",
                  "createdOn": "2023-11-07T05:31:56Z",
                  "icon": "<string>",
                  "id": "<string>",
                  "label": "<string>",
                  "locked": true,
                  "slug": "<string>",
                  "statusType": "TODO",
                  "updatedOn": "2023-11-07T05:31:56Z",
                  "uuid": "<string>"
                }
              ],
              "templateArticleId": "<string>",
              "updatedOn": "2023-11-07T05:31:56Z",
              "uuid": "7c9e667974254de944be07fc1f90ae7"
            },
            "projectId": "<string>",
            "runOnExistingContent": true,
            "showInTraining": true,
            "slug": "invoice-extractor",
            "subscription": "<string>",
            "testOptions": {},
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>",
            "validationErrors": {
              "instances": [
                {
                  "description": "<string>",
                  "message": "<string>",
                  "option": "<string>"
                }
              ]
            }
          },
          "changeSequence": 123,
          "createdOn": "2023-11-07T05:31:56Z",
          "execution": {
            "assistantId": "<string>",
            "changeSequence": 123,
            "context": {},
            "createdOn": "2023-11-07T05:31:56Z",
            "deleteLoggingOnSuccess": true,
            "description": "<string>",
            "documentFamilyId": "<string>",
            "endDate": "2023-11-07T05:31:56Z",
            "exceptionDetails": {
              "advice": "<string>",
              "cause": {},
              "description": "<string>",
              "documentationUrl": "<string>",
              "errorMessage": "<string>",
              "errorType": "<string>",
              "executedVersion": "<string>",
              "help": "<string>",
              "message": "<string>",
              "optionErrors": {},
              "stackTrace": [
                {}
              ],
              "statusCode": 123,
              "validationErrors": [
                {
                  "description": "<string>",
                  "message": "<string>",
                  "option": "<string>"
                }
              ]
            },
            "id": "<string>",
            "idempotencyKey": "<string>",
            "loggingEnabled": true,
            "organizationId": "<string>",
            "parentExecutionId": "<string>",
            "pipeline": {
              "exceptions": [
                {
                  "advice": "<string>",
                  "cause": {},
                  "description": "<string>",
                  "documentationUrl": "<string>",
                  "errorMessage": "<string>",
                  "errorType": "<string>",
                  "executedVersion": "<string>",
                  "help": "<string>",
                  "message": "<string>",
                  "optionErrors": {},
                  "stackTrace": [
                    {}
                  ],
                  "statusCode": 123,
                  "validationErrors": [
                    {
                      "description": "<string>",
                      "message": "<string>",
                      "option": "<string>"
                    }
                  ]
                }
              ],
              "id": "<string>",
              "ref": "<string>",
              "steps": [
                {
                  "conditional": "<string>",
                  "context": {},
                  "end": "<string>",
                  "exceptionDetails": {
                    "advice": "<string>",
                    "cause": {},
                    "description": "<string>",
                    "documentationUrl": "<string>",
                    "errorMessage": "<string>",
                    "errorType": "<string>",
                    "executedVersion": "<string>",
                    "help": "<string>",
                    "message": "<string>",
                    "optionErrors": {},
                    "stackTrace": [
                      {}
                    ],
                    "statusCode": 123,
                    "validationErrors": [
                      {
                        "description": "<string>",
                        "message": "<string>",
                        "option": "<string>"
                      }
                    ]
                  },
                  "extensionPackRef": "<string>",
                  "id": "<string>",
                  "inputId": "<string>",
                  "name": "<string>",
                  "optionTypes": {},
                  "options": {},
                  "outputId": "<string>",
                  "outputIds": "<string>",
                  "processingTime": 123,
                  "progress": 123,
                  "progressMax": 123,
                  "ref": "<string>",
                  "start": "<string>",
                  "status": "PENDING",
                  "statusMessage": "<string>",
                  "stepType": "<string>"
                }
              ],
              "valid": true
            },
            "priority": 123,
            "processingTime": 123,
            "sessionId": "<string>",
            "startDate": "2023-11-07T05:31:56Z",
            "status": "PENDING",
            "statusDetails": {
              "detail": "<string>",
              "message": "<string>",
              "progress": 123,
              "progressMax": 123,
              "stepStatus": "<string>"
            },
            "targets": {
              "instances": [
                {
                  "contentObjectId": "<string>",
                  "documentFamilyId": "<string>",
                  "labelsToApply": [
                    "<string>"
                  ],
                  "ref": "<string>",
                  "taxonomyRefs": [
                    "<string>"
                  ],
                  "type": "<string>"
                }
              ]
            },
            "updatedOn": "2023-11-07T05:31:56Z",
            "uuid": "<string>"
          },
          "id": "<string>",
          "updatedOn": "2023-11-07T05:31:56Z",
          "uuid": "<string>"
        }
      ],
      "updatedOn": "2023-11-07T05:31:56Z",
      "uuid": "<string>"
    }
  ],
  "first": true,
  "last": true,
  "number": 123,
  "numberOfElements": 123,
  "pageable": {
    "offset": 123,
    "pageNumber": 123,
    "pageSize": 123,
    "paged": true,
    "sort": {
      "empty": true,
      "sorted": true,
      "unsorted": true
    },
    "unpaged": true
  },
  "size": 123,
  "sort": {
    "empty": true,
    "sorted": true,
    "unsorted": true
  },
  "totalElements": 123,
  "totalPages": 123
}

Authorizations

x-api-key
string
header
required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Query Parameters

page
integer<int32>

Page number (1-indexed). Defaults to 1.

pageSize
integer<int32>

Number of items per page (1-1000). Defaults to 20, maximum 1000.

sort
string

Sort expression as field,direction. Direction is asc or desc. Multiple sort fields can be specified by repeating the parameter.

filter
string

RSQL/FIQL filter expression. Supported operators: == (equals), != (not equals), =like= (contains), =in= (in list), > / >= / < / <= (comparison), =isnull=true (is null), =isnull=false (is not null). Combine with ; (AND) or , (OR). Example: name=='Acme Corp';status==active

query
string

Full-text search query matching against the entity's searchable fields.

Response

Page of DocumentFamilyStatistics

Paginated response containing DocumentFamilyStatistics items.

content
object[]

Array of DocumentFamilyStatistics items on this page.

first
boolean

Whether this is the first page.

last
boolean

Whether this is the last page.

number
integer<int32>

Current page number (0-indexed).

numberOfElements
integer<int32>

Number of items on the current page.

pageable
object

Pagination metadata.

size
integer<int32>

Page size (number of items per page).

sort
object

Sort metadata.

totalElements
integer<int64>

Total number of items across all pages.

totalPages
integer<int32>

Total number of pages.