Get Analytics

4 min

Introduction

This API documentation is for the itranalytics endpoint that allows users to retrieve analytics related to income tax returns. The API requires specific headers and input data in JSON format, including a reference ID obtained from another API. Upon successful processing of the request, the API returns analytics data in the response body.

Sample cURL

curl --request POST \
  --url https://signzy.tech/api/v2/patrons/..your-patron-id../itranalytics \
  --header 'Accept: */*' \
  --header 'Accept-Language: en-US,en;q=0.8' \
  --header 'Authorization: <Access-Token>' \
  --header 'content-type: application/json' \
  --data '{"task":"getAnalytics","essentials":{"referenceId":"...referenceId from getReferenceId API..."}}'

Parameter Name	Data Type	Required	Description
task	string	Yes	The analytics task to perform. The only supported task is "getAnalytics" for retrieving income tax return analytics.
essentials	JSON	Yes	A JSON object that contains essential data for the API to process the request, including the referenceId obtained from the getReferenceId API.
referenceId	string	Yes	A reference ID is obtained from the getReferenceId API, which identifies the income tax return for which the analytics are requested.
Accept	string	No	The acceptable media types for the response. By default, the server can respond with any content type.
Accept-Language	string	No	The preferred language for the response, in case the server supports multiple languages.
Authorization	string	Yes	An access token that authenticates the user's access to the API.
Content-Type	string	Yes	The format of the input data must be set to application/json.

Sample Response

{
    "result": {
        "excelUrl" : "A Downloadable Excel Sheet URL"
        "data":  "JSON Data of ITR Analytics";
        "statusMessage": "Status Message",
        "referenceId": " Reference ID"
      }
    }

Parameter Name	Data Type	Required	Description
excelUrl	string	Yes	A downloadable Excel Sheet URL containing the data of the ITR Analytics.
data	string	Yes	JSON data containing the ITR Analytics.
statusMessage	string	Yes	A status message of the API call.
referenceId	string	Yes	Reference ID received from the getReferenceId API call.