VICIdial

Interact with VICIdial Non-Agent API

Actions58

Lead Management Actions
User Agent Management Actions
Campaign Management Actions
Phone DID Management Actions
List Management Actions
Reporting Monitoring Actions
System Info Actions
- Version
- Server Refresh
Other Operations Actions

Overview

This node interacts with the VICIdial Non-Agent API to export agent statistics data. Specifically, the "Agent Stats Export" operation allows users to retrieve detailed performance and activity reports for call center agents within a specified time range. This is useful for supervisors or administrators who want to analyze agent productivity, campaign effectiveness, or generate reports for further processing.

Typical use cases include:

Exporting agent call statistics for a given date/time range.
Filtering stats by specific agents, campaigns, or user groups.
Customizing output format (CSV, JSON, tab-delimited, pipe-delimited).
Including or excluding headers in the exported data.
Grouping results by campaign or other criteria.

For example, a call center manager could schedule this node to run daily, exporting the previous day's agent stats in CSV format for reporting or integration with other analytics tools.

Properties

Name	Meaning
Function	API function name; fixed to "agent_stats_export" for this operation.
User	API user credential used for authentication.
Pass	API password credential used for authentication.
Source	Description of what originated the API call; default is "n8n".
Datetime Start	Start datetime for the stats export in format "YYYY-MM-DD HH:MM:SS".
Datetime End	End datetime for the stats export in format "YYYY-MM-DD HH:MM:SS".
Agent User	Optional filter by specific agent user ID.
Campaign Id	Optional filter by campaign ID.
User Group	Optional filter by user group.
Stage	Output format of the exported data. Options: Csv, Tab, Pipe, Json.
Header	Whether to include header row in output. Options: YES, NO.
Time Format	Format for time fields in output. Options: H, HF, M, S (likely representing hours, hours+fraction, minutes, seconds).
Group By Campaign	Whether to group results by campaign. Options: YES, NO.

Output

The node outputs the raw response from the VICIdial API as JSON data in the json field of each item. The content corresponds to the requested export format (CSV, tab-delimited, pipe-delimited, or JSON) containing agent statistics for the specified filters and time range.

If the output format is one of the delimited text formats (CSV, tab, pipe), the json output will contain the raw text data as a string. If JSON format is selected, the output will be structured JSON data representing the agent stats.

No binary data output is indicated by the source code or properties.

Dependencies

Requires an API key credential (user and password) for authenticating with the VICIdial Non-Agent API.
The node uses the base URL configured in the credentials to send requests to the VICIdial API endpoint /vicidial.
No additional external dependencies are indicated beyond the API access.

Troubleshooting

Authentication errors: Ensure that valid API user and password credentials are provided. Incorrect credentials will cause authentication failures.
Invalid date/time format: The datetime_start and datetime_end must be in the exact format "YYYY-MM-DD HH:MM:SS". Incorrect formatting may result in API errors or empty responses.
Empty or incomplete data: Check that the date range covers periods where agent activity exists. Also verify optional filters like agent user or campaign ID do not exclude all data.
Output format issues: Selecting an unsupported or misspelled output format may cause unexpected results. Use one of the provided options: csv, tab, pipe, json.
API connectivity: Verify network connectivity and correct base URL configuration in credentials.

Links and References

VICIdial Official Documentation (for general API reference)
VICIdial Non-Agent API Guide (for details on agent stats export function)

This summary is based solely on static analysis of the provided source code and property definitions.