Accessing API Endpoints

Our API endpoints facilitate data retrieval and interaction with various resources. Here's how to interact with them:

1. Input and Output Format: All API requests and responses follow the JSON format. Input your data in JSON when making requests, and expect JSON-formatted responses.
   
   

2. Authentication: To access these endpoints, authenticate your requests by including the access token obtained from the authentication process in the headers of your API requests. This should be presented in the header of any request.
   
   

3. API Endpoint: Below are some key endpoint URLs you can utilize:

   • https://api.callation.com/api/v1/report
   • https://api.callation.com.au/api/v1/report
     
     

4. Input Requirements: Different reports will have different requirements, but generally speaking the minimum requirements of the input on any reporting endpoint are;

   • reportType - This is the report type to run. See section 5 on how to obtain this.
   • fromStamp - The timestamp to report from in local time.
   • toStamp - The timestamp to report to in local time.
   • timezone - Your local timezone (optional, will default to Melbourne/Australia if not set).
     
     

5. Report Types and Detailed Syntax: For reportType values or for specific syntax and options required for reports, filters, or users:

   • Open your preferred browser (Google Chrome or Firefox).
   • Access the desired functionality within the platform's portal.
   • Press F12 or right-click and select 'Inspect' to open the browser console.
   • Perform the action (e.g., run the report, apply filters).
   • In the Network tab of the console, look for the API request corresponding to your action.
   • Extract the JSON body of the request to understand the syntax and options used for the report or filters.
     
     

6. This method allows you to inspect network requests made by the platform, helping you replicate the syntax and options needed for unlisted endpoints or specific functionalities.
   
   

For further guidance or assistance in utilizing specific endpoints or understanding endpoint functionalities, refer to our documentation or reach out to our support team for detailed instructions.