Project Analytics

Retrieves the most expensive projects by credits spent.

get

Retrieves the most expensive projects by credits spent.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

onlyTop5booleanOptional

Whether to return only the top 5 projects.

Responses

200

403

Forbidden

get

/projects/analytics/expensive-projects

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

[
  {
    "name": "text",
    "description": "text",
    "dateAdded": "2025-12-06T04:05:46.360Z",
    "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
    "metadataValues": [
      {
        "isYes": true,
        "text": "text",
        "decimalValue": 1,
        "date": "2025-12-06T04:05:46.360Z",
        "categories": [
          "123e4567-e89b-12d3-a456-426614174000"
        ],
        "singleCategoryIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
        "metadata": {
          "name": "text",
          "description": "text",
          "dataType": "text",
          "isRequired": true,
          "options": [
            {
              "name": "text",
              "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    ],
    "resourceOwner": {
      "email": "text",
      "name": "text",
      "id": "text"
    },
    "credits": 1
  }
]

Retrieves a breakdown of credits for all projects.

get

Retrieves a breakdown of credits for all projects.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

pageNumberinteger · int32Optional

The page number to retrieve.

searchTermstringOptional

Optional search term to filter projects.

projectCreditSortinginteger · enumOptional

The sorting option for the results.

Possible values:

modelIdentifierstring · uuidOptional

Optional model identifier to filter by model.

Responses

200

Responseany

403

Forbidden

get

/projects/analytics/credit-breakdown

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

No content

Retrieves a breakdown of credits for a specific project.

get

Retrieves a breakdown of credits for a specific project.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

projectIdentifierstring · uuidRequired

The unique identifier of the project.

Responses

200

403

Forbidden

404

Not Found

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",
  "allAssitants": {
    "credits": 1,
    "jobs": 1
  },
  "flowCredits": 1,
  "flowJobs": 1,
  "credits": 1,
  "publicProjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "totalCredits": 1,
  "totalJobs": 1,
  "deleted": "2025-12-06T04:05:46.360Z"
}

Retrieves the cost breakdown grouped by model for the specified projects after a given date.

get

Retrieves the cost breakdown grouped by model for the specified projects after a given date.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

afterDatestring · date-timeOptional

The date after which to group costs.

projectObjectIdentifiersstring · uuid[]Optional

Optional list of project identifiers to filter.

onlyTop5booleanOptional

Whether to return only the top 5 models.

Responses

200

403

Forbidden

get

/projects/analytics/cost-by-model

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

[
  {
    "label": "text",
    "value": 1,
    "color": "text"
  }
]

Retrieves the cost breakdown grouped by model for a specific project after a given date.

get

Retrieves the cost breakdown grouped by model for a specific project after a given date.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the project.

Query parameters

afterDatestring · date-timeOptional

The date after which to group costs.

Responses

200

403

Forbidden

404

Not Found

get

/projects/{objectIdentifier}/analytics/cost-by-model

GET /projects/{objectIdentifier}/analytics/cost-by-model HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "label": "text",
    "value": 1,
    "color": "text"
  }
]

Retrieves the cost breakdown grouped by resource type for the specified projects after a given date.

get

Retrieves the cost breakdown grouped by resource type for the specified projects after a given date.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

afterDatestring · date-timeOptional

The date after which to group costs.

projectObjectIdentifiersstring · uuid[]Optional

Optional list of project identifiers to filter.

modelIdentifierstring · uuidOptional

Optional model identifier to filter by model.

Responses

200

403

Forbidden

get

/projects/analytics/cost-by-type

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

{
  "asssitant": 1,
  "overall": 1,
  "flow": 1
}

Retrieves the cost breakdown grouped by day for the specified projects after a given date.

get

Retrieves the cost breakdown grouped by day for the specified projects after a given date.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Query parameters

afterDatestring · date-timeOptional

The date after which to group costs.

projectObjectIdentifiersstring · uuid[]Optional

Optional list of project identifiers to filter.

Responses

200

403

Forbidden

get

/projects/analytics/cost-by-day

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

[
  {
    "date": "text",
    "overall": 1,
    "assistant": 1,
    "flow": 1
  }
]

Retrieves the cost breakdown grouped by day for a specific project after a given date.

get

Retrieves the cost breakdown grouped by day for a specific project after a given date.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

The unique identifier of the project.

Query parameters

afterDatestring · date-timeOptional

The date after which to group costs.

Responses

200

403

Forbidden

404

Not Found

get

/projects/{objectIdentifier}/analytics/cost-by-day

GET /projects/{objectIdentifier}/analytics/cost-by-day HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "date": "text",
    "overall": 1,
    "assistant": 1,
    "flow": 1
  }
]

Retrieves the latest balance for the organization.

get

Retrieves the latest balance for the organization.

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Responses

200

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: */*

{
  "creditsAmount": 1
}

PreviousProject Admin ACL NextProjects

Last updated 4 months ago