tap-five9

This is a Singer tap that produces JSON-formatted data following the Singer spec.

This tap:

• Pulls raw data from Five9
• Extracts the following resources:
  • Call Logs
  • Agent Login Logout
  • Agent Occupancy
  • Agent Information
• Outputs the schema for each resource
• Incrementally pulls data based on the input state

git clone [email protected]:Pathlight/tap-five9.git
cd tap-five9
pip install .

Config

See Five9 Configuration for more API detalis.

The tap accepts the following config items:

field	type	required	description
start_date	string	yes	RFC3339 date string "2017-01-01T00:00:00Z"
password	string	yes	Five9 password credentials
username	string	yes	Five9 username credentials
custom_reports	object	no	Stream specific reporting periods (see below)
poll_settings	object	no	Polling used for data extraction jobs (see below)

Example config:

{
  "start_date": "2017-01-01T00:00:00Z",
  "password": "<Five9 password>",
  "username": "<Five9 username>",
  "custom_reports": [
    {
      "stream_id": "custom_agent_reason_code_summary",
      "folder_name": "Pathlight Custom",
      "report_name": "Agent Reason Code Summary (Pathlight)",
      "key_properties": [
        "agent",
        "date"
      ],
      "datetime_fields": [
        "date",
        "timestamp"
      ],
      "replication_method": "INCREMENTAL",
      "valid_replication_keys": "date"
    }
  ],
}

Custom Reports

For periods the structure is as follows:

stream	reporting period
stream_name	the tap supports 1 days, 1 hours, and 5 minutes

Polling Behavior

For reports, we need to poll for the report status to see when it is completed. You can change these settings in order to adjust polling behavior.

stream	reporting period
delay	How long to wait between status requests, defaults to 5 seconds
timeout	How long to wait for the status request, defaults to 600 seconds

---

Copyright © 2018 Stitch