Reports
Reports (/public-api/app-reports/)
The Reports API enables you to fetch reports with respect to an app and its field mappings consist of field ids and field names and also have filter and projection functionalities.
To fetch the report, you must pass the id of the app in the payload.
Header Parameters
Request Parameters
The request will contain the following parameters.
app_id
Objec_id
Required
The ID of the app
enable_field_ma ppings
Boolean
Optional
True/False
Whether to enable or disable field mapping
offset
integer
Optional
0
The page number
limit
integer
Optional
20
The limit for the result
display_fields
List
Optional
The list of field ids in the result
stage_id
Objec_id
Optional
For filtering data with stage id
version
Integer
2
The value 1 refers to version 1 (actual field ids) and value 2 refers to version 2 (field ids are hashed)
String
Optional
The email address
datetime
Datetime
Optional
The date and time
phone
String
Optional
The telephone number
text
String
Optional
auto increment
Optional
Increases the number by 1
dd
timestamp
Optional
yyyy-MMdd
date
multiselect
Optional
Example Payload
If the request is valid, the server returns the HTTP 200 OK status code and the success message.
Successful Response
200
OK
If the request succeeds, the server returns the HTTP 200 and code along with the success message.
For example, a successful access token response may look like the following:
Error Response
The following table contains the other possible error response of this API.
Validation
Missing Access Token!
Validation
Missing Account ID!
Validation
Secret Not Found!
Validation
Unauthorized Token!
Validation
Unauthorized User!
Validation
Unauthorized Account!
Validation
app_id is missing in request params
Validation
Invalid parameter type
Validation
app_id must be object id.
Validation
the secret must be string
Validation
App Not Found!
Validation
Error in authenticating user
Error
Error in getting app fields from DB!
Error
Error in getting app field params!
Error
Error in validating data!
Error
Error in getting app reports from DB!
Error
Error in preparing field filters!
Error
Error while preparing filters!
Error
Error in getting app report nodes from DB!
Error
Error in formatting app type dd data!
Error
Error in parsing and formatting data!
Error
Error in formatting report data!
Error
Server error while getting app reports!
Example cURL
