Returns usage data information for a customer

get/customer-usage-data
SecuritybearerAuth
Request
query Parameters
page
required
integer <int32> (PageParam) >= 1

Page of results to show

Example: page=1
pageSize
required
integer <int32> (ResultsPerPageParam) [ 1 .. 1000 ]

Results to return per page

Example: pageSize=100
sort
string (SortParam)

Comma-delimited list of the fields to sort by - defaults to ascending order, suffix :desc to change

Example: sort=id,name | name:desc
fields
string (FieldsParam)

Comma-delimited list of the field(s) to return if only a subset is required

Example: fields=id,name
customerId
string (IdFilterParam)

Filter by customer id

Example: customerId=0
siteId
string (IdFilterParam)

Filter by site id

Example: siteId=0
billRunId
string (IdFilterParam)

Filter by bill run id

Example: billRunId=0
productReference
string (StringFilterParam)

Filter by product reference

Example: productReference=xyz | in:x,y | like:xyz
serviceId
string (StringFilterParam)

Filter by serviceId

Example: serviceId=xyz | in:x,y | like:xyz
eventDateFrom
string (DateTimeFilterParam)

Filter based on events from this date

Example: eventDateFrom=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
eventDateTo
string (DateTimeFilterParam)

Filter based on events until this date

Example: eventDateTo=yyyy-MM-ddTHH:mm:ssZ | lt:yyyy-MM-ddTHH:mm:ssZ | gt:yyyy-MM-ddTHH:mm:ssZ
destination
string (StringFilterParam)

Filter by destination/origin

Example: destination=xyz | in:x,y | like:xyz
excludeZeroValueRecords
string (BooleanFilterParam)

Filter out zero value entries

Example: excludeZeroValueRecords=true | false
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

Response samples
application/json
[
  • {
    • "id": 1,
    • "customerId": 0,
    • "siteId": 0,
    • "billRunId": 0,
    • "eventDate": "2019-08-24T14:15:22Z",
    • "productReference": 0,
    • "serviceId": "string",
    • "destination": "string",
    • "chargeGroupId": 1,
    • "callClass": "string",
    • "oneOffQuantity": 0,
    • "dataQuantity": 0,
    • "durationQuantity": 0,
    • "sellPrice": 0,
    • "preDiscountedSellPrice": 0,
    • "buyPrice": 0,
    • "ratedBuyPrice": 0,
    • "profit": 0,
    • "profitPercentage": 0,
    • "marginPercentage": 0,
    • "timeBand": "OFFPEAK",
    • "usageProductId": 1,
    • "usageDirection": "OUTBOUND",
    • "isdn": false,
    • "additionalInfoGeneral": "string",
    • "additionalInfoElectronic": "string",
    • "supplierAccountId": 1,
    • "fileName": "string",
    • "loadedDate": "2019-08-24",
    • "parserName": "string",
    • "fileType": "string"
    }
]