Get usage

GET 
/organizations/:organizationId/usage

Get usage for organization

Request

Path Parameters

organizationId stringrequired

The ID of organization.

Query Parameters

startDate numberrequired

Start date for usage request.

endDate numberrequired

End date for usage request.

Responses

200

application/json

Schema

Schema

data objectrequired
Organization usage object.
usageSms numberrequired
usageWhatsapp numberrequired
usageEmail numberrequired
usageSage numberrequired

Example (from schema)

{
  "data": {
    "usageSms": 0,
    "usageWhatsapp": 0,
    "usageEmail": 0,
    "usageSage": 0
  }
}

Example

{
  "data": {
    "usageSms": 1,
    "usageWhatsapp": 1,
    "usageEmail": 1,
    "usageSage": 1
  }
}

401

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Unauthenticated",
  "message": "Authentication is required and has failed or has not yet been provided."
}

403

The request has not permission.

application/json

Schema

Schema

error stringrequired

The request has not permission.

message stringrequired

The request has not permission message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "Forbidden",
  "message": "Access to the requested resource is forbidden."
}

404

The resource hasn't found.

application/json

Schema

Schema

error stringrequired

The resource hasn't found.

message stringrequired

The resource hasn't found message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ResourceNotFound",
  "message": "The requested resource could not be found."
}

422

The input data has invalid.

application/json

Schema

Schema

error stringrequired

The input data has invalid.

message stringrequired

The input data has invalid message.

Example (from schema)

{
  "error": "string",
  "message": "string"
}

Example

{
  "error": "ValidationError",
  "message": "Input data validation failed."
}

Loading...