GET /charge_rollups

Authorization Required
https://[your-subdomain].trackdrive.net/api/v1/charge_rollups

List billing records.

Returns aggregated billing records rolled up into hourly buckets per company, charge type, offer, and schedule, for reporting on charges such as calls, SMS, transcriptions, and number fees without querying individual charges. Filter by charge_type, offer_id, schedule_id, or ids, plus the standard date-range filters; the response includes summary totals. Requires the Billing permission.

Params

Param name Description
charge_type
Optional

Different types of charges including calls, SMS, transcriptions, reporting, and number-related fees.

  • Must be a String

offer_id
Optional

Refer to the offer api for details

schedule_id
Optional

Schedule internal id.

ids
Optional

Return records matching these ids.

  • Must be an array of decimal values. EG: [0, 1, 2, 3]

page
Optional

Return the next page of results.

  • Must be a number.

per_page
Optional

How many results to return per page. The default is 25.

  • Must be a number.

created_at_to
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String

created_at_from
Optional

Date formatted like 2016-01-01 12:25:15 -0500

  • Must be a String

fulltext
Optional

Search for any record that matches this text

  • Must be a String

time_zone
Optional

Date ranges will be parsed using this time zone.

columns
Optional
Specify the columns you would like returned by the API for a given resource. Limiting the columns can significantly increase API response time since only the requested data will be processed. columns=uuid,number,created_at

Must be any combination of:

  • id
  • legacy_id
  • type
  • uuid
  • created_at
  • updated_at
  • deleted_at
  • user_updated_at
  • routes_show_path
  • routes_edit_path
  • external_record_id
  • name
  • company_id
  • charge_type
  • offer_id
  • schedule_id
  • amount
  • sms_blast_messages_count
  • third_party_cost
  • sms_ai_charges_count
  • charges_count
  • lead_action_logs_count
  • transcriptions_count
  • dnc_check_logs_count
  • Must be a String

root
Optional

Pass root=false to return results without a root node and metadata.
For example:
GET /api/v1/calls?root=false will return [call1, call2, call3]
While:
GET /api/v1/calls will return {calls: [call1, call2, call3], metadata: {}}

  • Must be a boolean value: 1, true, yes, on, 0, false, no, off