POST api/2.0/crm/report/generate This function requires authentication

Description

Runs the report generation task with the parameters specified in the request.

Parameters

Name	Description	Type	Example
type sent in body	Report type	SalesByManagers, SalesForecast, SalesFunnel, WorkloadByContacts, WorkloadByTasks, WorkloadByDeals, WorkloadByInvoices, WorkloadByVoip, SummaryForThePeriod, SummaryAtThisMoment	SalesByManagers
timePeriod sent in body	Report time period	Today, Yesterday, Tomorrow, CurrentWeek, PreviousWeek, NextWeek, CurrentMonth, PreviousMonth, NextMonth, CurrentQuarter, PreviousQuarter, NextQuarter, CurrentYear, PreviousYear, NextYear, DuringAllTime	Today
managers sent in body	Managers	Collection of Guids	9924256A-739C-462b-AF15-E652A3B1B6EB

Example

POST api/2.0/crm/report/generate
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "type": "FixedBid",
  "timePeriod": "Today",
  "managers": [
    "9924256a-739c-462b-af15-e652a3b1b6eb",
    "98777e9c-f2a7-4e97-b314-ba9f92c2e882"
  ]
}

Returns

Report status

Example Response

application/json

{
  "status": 0,
  "response": {
    "Id": "wd2",
    "FileName": "FileName",
    "FileId": 1,
    "ReportType": 1,
    "Exception": "Exception",
    "Status": 1,
    "Origin": 1,
    "Obj": null
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <Id>wd2</Id>
    <FileName>FileName</FileName>
    <FileId>1</FileId>
    <ReportType>1</ReportType>
    <Exception>Exception</Exception>
    <Status>1</Status>
    <Origin>1</Origin>
    <Obj />
  </response>
</result>