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
chevron-right
200

OK

namestring · nullableRequired
descriptionstring · nullableRequired
dateAddedstring · date-time · nullableRequired
objectIdentifierstring · uuidRequired
creditsnumber · double · nullableRequired
get
/projects/analytics/expensive-projects

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
chevron-right
200

OK

anyOptional
get
/projects/analytics/credit-breakdown

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
chevron-right
200

OK

projectNamestring · nullableOptional
flowCreditsnumber · doubleOptional
flowJobsinteger · int32Optional
creditsnumber · doubleOptional
publicProjectIdentifierstring · uuidOptional
totalCreditsnumber · doubleOptional
totalJobsinteger · int32Optional
deletedstring · date-time · nullableOptional
get
/projects/{projectIdentifier}/analytics/credit-breakdown

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
chevron-right
200

OK

labelstring · nullableOptional
valuenumber · doubleOptional
colorstring · nullableOptional
get
/projects/analytics/cost-by-model

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
chevron-right
200

OK

labelstring · nullableOptional
valuenumber · doubleOptional
colorstring · nullableOptional
get
/projects/{objectIdentifier}/analytics/cost-by-model

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
chevron-right
200

OK

asssitantnumber · doubleOptional
overallnumber · doubleOptional
flownumber · doubleOptional
get
/projects/analytics/cost-by-type

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
chevron-right
200

OK

datestring · nullableOptional
overallnumber · doubleOptional
assistantnumber · doubleOptional
flownumber · doubleOptional
get
/projects/analytics/cost-by-day

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
chevron-right
200

OK

datestring · nullableOptional
overallnumber · doubleOptional
assistantnumber · doubleOptional
flownumber · doubleOptional
get
/projects/{objectIdentifier}/analytics/cost-by-day

Retrieves the latest balance for the organization.

get

Retrieves the latest balance for the organization.

Authorizations
AuthorizationstringRequired

Bearer authentication with JWT

Responses
chevron-right
200

OK

creditsAmountnumber · doubleOptional
get
/projects/balance/latest

Last updated