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

    • 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, ...

    • 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 ...

    • Qvara: Create a user and assign permissions

      What are Users? User accounts play a vital role in allowing customers to access their phone system. This includes access to features such as faxing, reporting, and extension customization. Additionally, users who would like more granular control over ...

    • My Phone Number Shows up as "Spam Risk"

      There are multiple factors that determine whether an incoming call would be labeled “Spam Likely” or “Spam Risk”. Many of these factors are controlled by regulatory agencies and not by PrimeVOX directly. Customers Still Switching to PrimeVOX If you ...

    • Call History & Call Recordings

      Call History Overview One of the most useful features of your Primevox phone system is the Call History (CDR) page. When logged in to the Primevox Dashboard at pbx.primevox.net, the Call History (CDR) tab can be found by selecting the “V2 Reports” ...