POST api/TwigsReport/twigs_dashboard

Request Information

URI Parameters

None.

Body Parameters

twigs_input
NameDescriptionTypeAdditional information
to_date

date

None.

from_date

date

None.

branch_id

integer

None.

connection_string

string

None.

token

string

None.

Request Formats

application/json, text/json

Sample:
{
  "to_date": "2025-12-21T07:56:28.9323081+04:00",
  "from_date": "2025-12-21T07:56:28.9323081+04:00",
  "branch_id": 3,
  "connection_string": "sample string 4",
  "token": "sample string 5"
}

application/xml, text/xml

Sample:
<twigs_input xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromptTech.CRM.DAO">
  <branch_id>3</branch_id>
  <connection_string>sample string 4</connection_string>
  <from_date>2025-12-21T07:56:28.9323081+04:00</from_date>
  <to_date>2025-12-21T07:56:28.9323081+04:00</to_date>
  <token>sample string 5</token>
</twigs_input>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

twigs_dashboard_response
NameDescriptionTypeAdditional information
success

boolean

None.

message

string

None.

twigs_dashboard_bars

Collection of twigs_dashboard_bar

None.

twigs_dashboard_pies

Collection of twigs_dashboard_pie

None.

twigs_dashboard_lines

Collection of twigs_dashboard_line

None.

Response Formats

application/json, text/json

Sample:
{
  "success": true,
  "message": "sample string 2",
  "twigs_dashboard_bars": [
    {
      "month": "sample string 1",
      "amount": 2.0
    },
    {
      "month": "sample string 1",
      "amount": 2.0
    }
  ],
  "twigs_dashboard_pies": [
    {
      "branch": "sample string 1",
      "amount": 2.0
    },
    {
      "branch": "sample string 1",
      "amount": 2.0
    }
  ],
  "twigs_dashboard_lines": [
    {
      "date": "2025-12-21T07:56:28.9323081+04:00",
      "date_for_graph": "sample string 2",
      "amount": 3.0
    },
    {
      "date": "2025-12-21T07:56:28.9323081+04:00",
      "date_for_graph": "sample string 2",
      "amount": 3.0
    }
  ]
}

application/xml, text/xml

Sample:
<twigs_dashboard_response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PromptTech.CRM.CustomerApp.Models">
  <message>sample string 2</message>
  <success>true</success>
  <twigs_dashboard_bars>
    <twigs_dashboard_bar>
      <amount>2</amount>
      <month>sample string 1</month>
    </twigs_dashboard_bar>
    <twigs_dashboard_bar>
      <amount>2</amount>
      <month>sample string 1</month>
    </twigs_dashboard_bar>
  </twigs_dashboard_bars>
  <twigs_dashboard_lines>
    <twigs_dashboard_line>
      <amount>3</amount>
      <date>2025-12-21T07:56:28.9323081+04:00</date>
      <date_for_graph>sample string 2</date_for_graph>
    </twigs_dashboard_line>
    <twigs_dashboard_line>
      <amount>3</amount>
      <date>2025-12-21T07:56:28.9323081+04:00</date>
      <date_for_graph>sample string 2</date_for_graph>
    </twigs_dashboard_line>
  </twigs_dashboard_lines>
  <twigs_dashboard_pies>
    <twigs_dashboard_pie>
      <amount>2</amount>
      <branch>sample string 1</branch>
    </twigs_dashboard_pie>
    <twigs_dashboard_pie>
      <amount>2</amount>
      <branch>sample string 1</branch>
    </twigs_dashboard_pie>
  </twigs_dashboard_pies>
</twigs_dashboard_response>