Generate Report

Use this API to generate a BIK report for a store from an external source.

Request Parameters

Name	Type	Required/Optional	Description
reportType	ReportTypes	Required	The type of report that is to be generated. Check the ReportTypes here.
reportName	ReportNames	Required	The name of the report to be generated. This is the same as the report names shown in BIK and is case-sensitive. Check the ReportNames list here.
dateRange	DateRange	Required	Object type containing start date and end date for the report. Check the DateRange type here.
emails	string[]	Required	List of email IDs to send the report to after generation.
reportDescription	string	Optional	A description of the report to be generated.
filters	Filters	Optional	Optional filters to be applied to the report. Check the Filters type here.

Request Information

Category	Value
HTTP request	POST
URL	https://bikapi.bikayi.app/integrations/bikPlatformFunctions-generateReport

Sample Request

curl --location --request POST 'https://bikapi.bikayi.app/integrations/bikPlatformFunctions-generateReport' \
--header 'Authorization: Basic AUTH_TOKEN' \
--header 'Content-Type: application/json' \
--data-raw '{
 "reportName": "Agent Engagement",
  "dateRange": { 
    "startDate": "2025-07-27T18:30:00.540Z",
    "endDate": "2025-08-29T18:29:59.540Z" 
  },
  "filters": {
    "channel": "whatsapp",
    "groupBy": "week"
  },
"reportType": "Helpdesk",
"emails": ["example@example.com"]
}'

JSON response example:

{
    "status": 200,
    "success": true,
    "data": {
        "reportHistoryId": 44589
    }
}

Response parameters

Name	Type	Description
status	number	Response status
success	boolean	Indicates if the response is successful
data.reportHistoryId	number	Unique identifier for the history id for the report (used to get report by id)

Report Types

Name	Type	Description
Overall	string	Overall reports category
Campaigns	string	Campaigns reports category
Helpdesk	string	Helpdesk reports category
Journeys	string	Journeys reports category
Widgets	string	Widgets reports category

Report Names

Name
Popup Conversions
Campaign(s) Message Failure Overview
Whatsapp Payment Report
Agent Engagement
Overall CSAT/NPS
Channel Engagement
Label Engagement
Customer Conversations
Events conversion report
Ticket’s Overview
Journey overall report
Campaign Summary Report
Campaign(s) Opt-Out and Bounce
Campaign(s) Conversion Events Report
Ledger report
Agent SLA report
Price please automation report
Customer Delivery Failure Report
Overall customers report
Popup Insights
Customer Conversion Summary report
Customer ticket report
Journey keywords report

Date Range Type

Name	Type	Description
startDate	string	ISO string for the start date timestamp for the report.
endDate	string	ISO string for the end date timestamp for the report.

Filters Type

Name	Type	Description
channel	Channels	Channel to get the report data for (in case of applicable reports only). Check the Channels type here.
groupBy	string	The time duration ("day" | "week" | "month") to group the data by (in case of applicable reports only).

Channels Type

Name	Type	Description
whatsapp	string	Whatsapp channel identifier
email	string	Email channel identifier
instagram	string	Instagram channel identifier
messenger	string	Messenger channel identifier
livechat	string	Livechat channel identifier

Errors

Error Code	Meaning
400	Invalid payload! -- Your request is invalid/invalid parameters.
401	Unauthorized -- User is not authenticated.
404	Not Found -- The specified API could not be found.
500	Internal Server Error -- We had a problem with our server. Try again later.

Error response example:

{
  "status": 400,
  "errors": [
    {
      "message": "Invalid payload!"
    }
  ]
}