Project Analytics

Get credit breakdown for a project.

get

Retrieves a breakdown of credits for a specific project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

Responses

200

OK

projectNamestring · nullableOptional

flowCreditsnumber · doubleOptional

flowJobsinteger · int32Optional

creditsnumber · doubleOptional

publicProjectIdentifierstring · uuidOptional

totalCreditsnumber · doubleOptional

totalJobsinteger · int32Optional

deletedstring · date-time · nullableOptional

ocrPageCountinteger · int32Optional

layoutPageCountinteger · int32Optional

pageCountinteger · int32Optional

ocrCreditsCostnumber · doubleOptional

layoutCreditsCostnumber · doubleOptional

fileCreditsCostnumber · doubleOptional

403

Forbidden

get/projects/{projectIdentifier}/analytics/credit-breakdown

GET /projects/{projectIdentifier}/analytics/credit-breakdown HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "projectName": "text",
  "allAssistants": {
    "credits": 1,
    "jobs": 1
  },
  "flowCredits": 1,
  "flowJobs": 1,
  "credits": 1,
  "publicProjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "totalCredits": 1,
  "totalJobs": 1,
  "deleted": "2026-01-01T00:00:00.000Z",
  "ocrPageCount": 1,
  "layoutPageCount": 1,
  "pageCount": 1,
  "ocrCreditsCost": 1,
  "layoutCreditsCost": 1,
  "fileCreditsCost": 1
}

Get latest balance.

get

Retrieves the latest balance for the organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

availableCreditsnumber · doubleRequired

creditsnumber · doubleRequired

403

Forbidden

get/projects/balance/latest

GET /projects/balance/latest HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "availableCredits": 1,
  "credits": 1
}

Get project analytics.

get

Retrieves project analytics for the organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageSizeinteger · int32Optional

pageNumberinteger · int32Optional

searchTextstringOptional

sortingstringOptional

descbooleanOptionalDefault: true

filterColumnstring · enumOptionalPossible values:

filterOperationstring · enumOptionalPossible values:

filterSearchTermstringOptional

Responses

200

OK

totalCountinteger · int32Optional

403

Forbidden

get/projects/analytics

GET /projects/analytics HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "resourceOwnerId": "text",
      "resourceOwner": {
        "name": "text",
        "id": "text",
        "email": "text",
        "picture": "text",
        "roles": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "chatCount": 1,
      "chatCredits": 1,
      "flowCount": 1,
      "flowCredits": 1,
      "jobCount": 1,
      "totalCredits": 1,
      "deleted": true,
      "id": 1,
      "ocrPageCount": 1,
      "layoutPageCount": 1,
      "pageCount": 1,
      "ocrCreditsCost": 1,
      "layoutCreditsCost": 1,
      "fileCreditsCost": 1,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      }
    }
  ],
  "totalCount": 1
}

Export project analytics as Excel.

get

Exports all project analytics for the organization as an Excel file.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

string · binaryOptional

403

Forbidden

get/projects/analytics/export

GET /projects/analytics/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Get assistant analytics.

get

Retrieves assistant analytics for the organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageSizeinteger · int32Optional

pageNumberinteger · int32Optional

searchTextstringOptional

filterColumnstring · enumOptionalPossible values:

filterOperationstring · enumOptionalPossible values:

filterSearchTermstringOptional

sortingstringOptional

descbooleanOptionalDefault: true

Responses

200

OK

totalCountinteger · int32Optional

403

Forbidden

get/projects/assistants/analytics

GET /projects/assistants/analytics HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "dateModified": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "resourceOwnerId": "text",
      "userIds": [
        "text"
      ],
      "resourceOwner": {
        "name": "text",
        "id": "text",
        "email": "text",
        "picture": "text",
        "roles": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "users": [
        {
          "name": "text",
          "id": "text",
          "email": "text",
          "picture": "text",
          "roles": [
            {
              "id": "text",
              "name": "text"
            }
          ]
        }
      ],
      "documentCount": 1,
      "totalFileSizeBytes": 1,
      "assistantMessageCount": 1,
      "userMessageCount": 1,
      "totalCount": 1,
      "credits": 1,
      "deleted": true,
      "projectName": "text",
      "projectObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "estimatedTokenCount": 1
    }
  ],
  "totalCount": 1
}

Export assistant analytics as Excel.

get

Exports all assistant analytics for the organization as an Excel file.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

string · binaryOptional

403

Forbidden

get/projects/assistants/analytics/export

GET /projects/assistants/analytics/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Get flow analytics.

get

Retrieves flow analytics for the organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageSizeinteger · int32Optional

pageNumberinteger · int32Optional

searchTextstringOptional

filterColumnstring · enumOptionalPossible values:

filterOperationstring · enumOptionalPossible values:

filterSearchTermstringOptional

sortingstringOptional

descbooleanOptionalDefault: true

Responses

200

OK

totalCountinteger · int32Optional

403

Forbidden

get/projects/flows/analytics

GET /projects/flows/analytics HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "dateAdded": "2026-01-01T00:00:00.000Z",
      "dateModified": "2026-01-01T00:00:00.000Z",
      "name": "text",
      "resourceOwnerId": "text",
      "resourceOwner": {
        "name": "text",
        "id": "text",
        "email": "text",
        "picture": "text",
        "roles": [
          {
            "id": "text",
            "name": "text"
          }
        ]
      },
      "groupCount": 1,
      "promptCount": 1,
      "runCount": 1,
      "credits": 1,
      "playbooks": [
        "text"
      ],
      "deleted": true,
      "projectName": "text",
      "projectObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "totalCount": 1
}

Export flow analytics as Excel.

get

Exports all flow analytics for the organization as an Excel file.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

string · binaryOptional

403

Forbidden

get/projects/flows/analytics/export

GET /projects/flows/analytics/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Get Word Add-In analytics.

get

Retrieves per-user Word Add-In credit usage analytics for the organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageSizeinteger · int32Optional

pageNumberinteger · int32Optional

sortingstringOptional

descbooleanOptionalDefault: true

Responses

200

OK

totalCountinteger · int32Optional

403

Forbidden

get/projects/word-addin/analytics

GET /projects/word-addin/analytics HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "userIdentifier": "text",
      "userName": "text",
      "credits": 1,
      "requestCount": 1
    }
  ],
  "totalCount": 1
}

Export Word Add-In analytics as Excel.

get

Exports all per-user Word Add-In credit usage analytics for the organization as an Excel file.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

string · binaryOptional

403

Forbidden

get/projects/word-addin/analytics/export

GET /projects/word-addin/analytics/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary

Get analytics for the current user.

get

Returns the credit and resource usage summary for the currently authenticated user.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

reviewJobsinteger · int32Optional

reviewCreditsnumber · doubleOptional

totalCreditsnumber · doubleOptional

totalJobsinteger · int32Optional

ocrPageCountinteger · int32Optional

layoutPageCountinteger · int32Optional

pageCountinteger · int32Optional

ocrCreditsCostnumber · doubleOptional

layoutCreditsCostnumber · doubleOptional

fileCreditsCostnumber · doubleOptional

401

Unauthorized

403

Forbidden

get/projects/admin/current-user

GET /projects/admin/current-user HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "reviewJobs": 1,
  "reviewCredits": 1,
  "chat": {
    "credits": 1,
    "jobs": 1
  },
  "conversation": {
    "credits": 1,
    "jobs": 1
  },
  "chatDocuments": {
    "credits": 1,
    "jobs": 1
  },
  "chatTextAnalysis": {
    "credits": 1,
    "jobs": 1
  },
  "totalCredits": 1,
  "totalJobs": 1,
  "ocrPageCount": 1,
  "layoutPageCount": 1,
  "pageCount": 1,
  "ocrCreditsCost": 1,
  "layoutCreditsCost": 1,
  "fileCreditsCost": 1
}

Get all organization members with analytics.

get

Returns a paginated, optionally filtered list of organization members and their analytics. Requires Owner role.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

searchTextstringOptional

pageNumberinteger · int32OptionalDefault: 1

pageSizeinteger · int32OptionalDefault: 100

sortingstringOptional

descbooleanOptionalDefault: true

filterColumnstringOptional

filterOperationstring · enumOptionalPossible values:

filterSearchTermstringOptional

Responses

200

OK

totalCountinteger · int32Optional

401

Unauthorized

403

Forbidden

get/projects/admin/users

GET /projects/admin/users HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "name": "text",
      "id": "text",
      "email": "text",
      "picture": "text",
      "roles": [
        {
          "id": "text",
          "name": "text"
        }
      ],
      "lastLogin": "2026-01-01T00:00:00.000Z",
      "loginsCount": 1,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "flows": 1,
      "assistants": 1,
      "totalCredits": 1,
      "flowCredits": 1,
      "assistantCredits": 1,
      "ocrPageCount": 1,
      "layoutPageCount": 1,
      "pageCount": 1,
      "ocrCreditsCost": 1,
      "layoutCreditsCost": 1,
      "fileCreditsCost": 1
    }
  ],
  "totalCount": 1
}

Export user analytics data for the organization.

get

Exports the organization's user analytics as a downloadable Excel (.xlsx) file. Requires Owner role.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

OK

string · binaryOptional

401

Unauthorized

403

Forbidden

get/projects/admin/users/export

GET /projects/admin/users/export HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

binary