extension/report/channel_payout/get

This returns the list of supported channel payout data for the Equotix One account.

Request

Body Params application/json

domain

string

required

The domain you are assigned to authenticate your Equotix One account.

api_key

string

required

The email address assigned to the user account in your Equotix One.

auth_timestamp

integer

required

The unix timestamp used to sign this API request.

auth_signature

string

required

The calculated signature for this API request.

channel_id

integer

required

The channel ID for the payout data.

date_start

string

required

The date start for the payout data. Max of 15 days data.

date_end

string

required

The date end for the payout data. Max of 15 days data.

type

string

optional

Accepts "formatted" or "raw". Default "raw".

string

optional

The next page token returned from previous API call if there's a next page.

Example

{
  "domain": "string",
  "api_key": "string",
  "auth_timestamp": 0,
  "auth_signature": "string",
  "channel_id": 0,
  "date_start": "string",
  "date_end": "string",
  "type": "string",
  "next": "string"
}

Responses

🟢200Success

application/json

Body

error

array[string]

optional

Returns only if there is an error.

string

optional

Returns the next page token for the API use, if there's more results available.

results

array [object]

optional

The list of payout data available if there is no error. Different channel has different format.

Example

{
  "error": [
    "string"
  ],
  "more": "string",
  "results": [
    {}
  ]
}