Usage

Yumeru API (1.0.0)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://api-docs.yumeru.ai/_mock/openapi/

Index

Operations

Health

Operations

Usage

Operations

Get usage stats for an organization

Request

Get usage stats for a specific organization

Path
organizationIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/usage/{organizationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Organization's usage stats

Bodyapplication/json
messagestring
dataobject
Response
application/json
{
  "message": "string",
  "data": {
    "id": 0,
    "organizationId": "string",
    "month": 0,
    "year": 0,
    "contactsEnriched": 0,
    "contactsLimit": 0,
    "phoneNumbersUsed": 0,
    "phoneNumbersLimit": 0,
    "concurrentCallsLimit": 0,
    "monthlyMinutesUsed": 0,
    "monthlyMinutesLimit": 0,
    "dailyMinutesLimit": 0,
    "resetDate": "string",
    "createdAt": "string",
    "updatedAt": "string"
  }
}

Get weekly usage for an organization

Request

Get weekly usage for a specific organization

Path
organizationIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/usage/{organizationId}/weekly' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Weekly minutes usage

Bodyapplication/json
messagestring
dataArray of objects
Response
application/json
{
  "message": "string",
  "data": [
    { … }
  ]
}

Get quota overview for an organization

Request

Get quota overview for a specific organization

Path
organizationIdstringrequired
curl -i -X GET \
  'https://api-docs.yumeru.ai/_mock/openapi/usage/{organizationId}/quotas' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Usage quotas overview

Bodyapplication/json
messagestring
dataobject
Response
application/json
{
  "message": "string",
  "data": {
    "minutes": { … },
    "contacts": { … },
    "phoneNumbers": { … },
    "startDate": "string",
    "resetDate": "string"
  }
}

Agents

Operations

Campaigns

Operations

Meetings

Operations

Webhooks

Operations