Reports & Analytics (V2)

Reports & Analytics (V2)

eFax Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/efax

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)

 

Extension Volume Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/extvolume

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)

 

Geographical Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/geography

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)

 

Inbound/DID Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/inbound

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)

 

IVR Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/ivr

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)

 

Queues: Basic Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/queue

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)

 

Ring Group Analysis (Raw Data)

REQUEST: GET https://pbx.primevox.net/api/reports/raw/ringgroup/v2

  • NOTE: All parameters are Case Sensitive.
  • auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot of nonsense.
  • containerID (integer) is the 6-digit Container ID number that is present in the top-left corner of the Dashboard when logged into a particular container.
  • tenantID (integer) - Optional - is the 3-digit (or 0/omitted) Tenant ID number that represents a customer on a container. When omitted (or set to 0) the system assumes you are referring to the Default Tenant.
  • fromDate - Optional - If omitted, defaults to "Today at 00:00:00". Format: YYYY-MM-DD HH:MM:SS
  • toDate - Optional - If omitted, defaults to "Today at 23:59:59". Format: YYYY-MM-DD HH:MM:SS
  • utcOffset - Optional - The minutes your customer/browser is away from UTC. Example: America/Chicago timezone is -300 (negative 300) minutes from UTC). Results will be returned in this time offset. Default is 0 (UTC)
  • lastEventOnly - Optional - Leave this off (0) to receive ALL ring group events for ALL calls in this date range. If an individual caller goes through 3 ring groups (like in a phase/cascade configuration) then you will receive all 3 events (2 timeout events + the last result event). Set this to 1 to make our API return only the last (result) event. This will return unique calls, with only the very last ring group event. If you don't have ring groups that cascade, then this option will not do anything regardless of how it's set.

    • Related Articles

    • VIP Callers

      What is a VIP Caller? VIP Callers are recognized phone numbers that receive customized call routing within your phone system. When a call comes in, the system checks the caller’s number against your VIP list and, if there’s a match, routes it to a ...

    • AnswerCARE Troubleshooting

      Depending on how AnswerCARE has been set up, the number of Agencies, Urgent boxes, Non-Urgent boxes, DISA Lines, Spoofing lines, Configurations, and Settings, PrimeVOX AnswerCARE troubleshooting can be very simple or very complex however, ...

    • Dial-by-Name Directories

      What Is a Dial-by-Name Directory? A Dial-by-Name Directory allows callers to search for and connect with users by entering the first few letters of their name using a phone keypad. This is especially useful in larger organizations where remembering ...

    • Real-Time Data (V2)

      Real-Time Queues REQUEST: GET https://pbx.primevox.net/api/reports/raw/queue/realtime?auth=&containerID=&tenantID= NOTE: All parameters are Case Sensitive. auth (string) is the string of text in the phone system's Advanced menu. It looks like a lot ...

    • Call CAPTCHA

      What is a Call CAPTCHA? A Call CAPTCHA is a voice security feature that helps protect your phone system from spam and robocalls. Similar to the CAPTCHAs you encounter on websites (e.g., "I'm not a robot" checkboxes), Call CAPTCHA challenges the ...