API Version: 6.5

Billable other data

Permissions

Requires System-Admin or Billing Call-Summary permissions. A user with Billing / Call Reporting permission may also read this data for companies they have permission to.

command 'readUserCount'

Path: /rest/call/readUserCount

All of the scope parameters are optional.

The calldate column is returned as a string, but can be translated to a real date simply by passing it to Javascript using new Date(string).

All of the fields under properties are optional, and are filled when available.

{
	"type": "cdr",
	"scope": {
		"company": ["company", ...], (optional, default to all)
		"month": month-number-to-report (optional, default of month-to-date)
	}
}

Return value:

{
    "result": "success",
    "values": {
        "companyID": {
            "name": "Company Name",
            "days": days-in-report,
            "dates": {
                "yyyy-mm-dd": peak-users,
                "yyyy-mm-dd": peak-users,
                "yyyy-mm-dd": peak-users,
                "yyyy-mm-dd": peak-users,
                "yyyy-mm-dd": peak-users,
                ...
            },
            "billableUserDaysPerDay": billableUserDaysPerDay,
            "billableUserDaysForMonth": billableUserDaysForMonth
        },
        ...
        (repeat per company)
    }
}

Example

{
    "type": "cdr",
    "scope": {
        "company": [
            "test"
        ],
        "month": 2
    }
}

{
    "result": "success",
    "values": {
        "test": {
            "name": "Test Company",
            "days": 28,
            "dates": {
                "2017-02-28": 3,
                "2017-02-27": 3,
                "2017-02-26": 3,
                "2017-02-25": 3,
                "2017-02-24": 3,
                "2017-02-23": 3,
                "2017-02-22": 3,
                "2017-02-21": 3,
                "2017-02-20": 3,
                "2017-02-19": 3,
                "2017-02-18": 3,
                "2017-02-17": 3,
                "2017-02-16": 3,
                "2017-02-15": 3,
                "2017-02-14": 2,
                "2017-02-13": 2,
                "2017-02-12": 2,
                "2017-02-11": 2,
                "2017-02-10": 2,
                "2017-02-09": 2,
                "2017-02-08": 2,
                "2017-02-07": 2,
                "2017-02-06": 2,
                "2017-02-05": 2,
                "2017-02-04": 2,
                "2017-02-03": 2,
                "2017-02-02": 0,
                "2017-02-01": 0
            },
            "billableUserDaysPerDay": 2,
            "billableUserDaysForMonth": 56
        }
    }
}

command 'readDDICount'

Path: /rest/call/readDDICount

All of the scope parameters are optional.

The calldate column is returned as a string, but can be translated to a real date simply by passing it to Javascript using new Date(string).

All of the fields under properties are optional, and are filled when available.

{
	"type": "cdr",
	"scope": {
		"company": ["company", ...], (optional, default to all)
		"month": month-number-to-report (optional, default of month-to-date)
	}
}

Return value:

{
    "result": "success",
    "values": {
        "companyID": {
            "name": "Company Name",
            "days": days-in-report,
            "dates": {
                "yyyy-mm-dd": peak-ddi-count,
                "yyyy-mm-dd": peak-ddi-count,
                "yyyy-mm-dd": peak-ddi-count,
                "yyyy-mm-dd": peak-ddi-count,
                "yyyy-mm-dd": peak-ddi-count,
                ...
            },
            "billableDDIDaysPerDay": billableDDIDaysPerDay,
            "billableDDIDaysForMonth": billableDDIDaysForMonth
        },
        ...
        (repeat per company)
    }
}

Example

{
    "type": "cdr",
    "scope": {
        "company": [
            "test"
        ],
        "month": 2
    }
}

{
    "result": "success",
    "values": {
        "test": {
            "name": "Test Company",
            "days": 28,
            "dates": {
                "2017-02-28": 13,
                "2017-02-27": 13,
                "2017-02-26": 13,
                "2017-02-25": 13,
                "2017-02-24": 13,
                "2017-02-23": 13,
                "2017-02-22": 13,
                "2017-02-21": 13,
                "2017-02-20": 13,
                "2017-02-19": 13,
                "2017-02-18": 13,
                "2017-02-17": 13,
                "2017-02-16": 13,
                "2017-02-15": 13,
                "2017-02-14": 12,
                "2017-02-13": 12,
                "2017-02-12": 12,
                "2017-02-11": 12,
                "2017-02-10": 12,
                "2017-02-09": 12,
                "2017-02-08": 12,
                "2017-02-07": 3,
                "2017-02-06": 3,
                "2017-02-05": 3,
                "2017-02-04": 3,
                "2017-02-03": 2,
                "2017-02-02": 0,
                "2017-02-01": 0
            },
            "billableDDIDaysPerDay": 10,
            "billableDDIDaysForMonth": 280
        }
    }
}