Theme

BI reports API (old CRM)

Written by

in

General

List of business units

GET /api/reports/business-units

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "businessUnits": [
      {
        "id": 1,
        "name": "Merkur"
      },
      {
        "id": 4,
        "name": "Mars"
      }
    ]
  }
}

List of consultants

GET /api/reports/consultants

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "consultants": [
      {
        "id": 73,
        "first_name": "Test",
        "last_name": "Business Manager"
      },
      {
        "id": 77,
        "first_name": "Test",
        "last_name": "Executive consultant"
      },
      {
        "id": 79,
        "first_name": "Test",
        "last_name": "Developer"
      }
    ]
  }
}

List of available process statuses

GET /api/reports/processes-status-list

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "statuses": {
      "1": "Created",
      "2": "Request",
      "3": "Candidate Accepted",
      "4": "Candidate Rejected",
    }
  }
}

Publications

Amount of published

GET /api/reports/amount-of-published

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -1 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "byUnits": [
      {
        "amount": 124,
        "name": "Che IT Group"
      },
      {
        "amount": 71,
        "name": "Venus "
      }
    ],
    "byConsultant": [
      {
        "amount": 123,
        "consultant_name": "Benhard Dushaj"
      },
      {
        "amount": 71,
        "consultant_name": "Mohi Heidar"
      }
    ]
  }
}

Top publications

GET /api/reports/top-publications

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -1 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "topPublications": [
      {
        "businessUnitName": "Che IT Group",
        "consultantName": "Benhard Dushaj",
        "vacancyName": "Key Account Manager B2B (m/w)",
        "vacancyId": 1229,
        "amountTotal": 5,
        "amountInProgress": 1,
        "amountActive": 0
      },
      {
        "businessUnitName": "Venus ",
        "consultantName": "Mohi Heidar",
        "vacancyName": "Agile Project Manager (m/w/d)",
        "vacancyId": 1724,
        "amountTotal": 5,
        "amountInProgress": 1,
        "amountActive": 0
      }
    ]
  }
}

Applications

Applications by source

GET /api/reports/applications-by-source

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -1 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "applicationsBySource": [
      {
        "sourceId": null,
        "source": null,
        "amount": 121
      },
      {
        "sourceId": "",
        "source": "Others",
        "amount": 0
      }
    ]
  }
}

Recruitment success

Interview progress

GET /api/reports/interview-progress

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -1 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

Example response:

{
  "status": "success",
  "message": "",
  "data": {
    "interviewProgress": [
      {
        "month": "2022-09",
        "interview1": 0,
        "interview2": 0,
        "interview3": 0
      },
      {
        "month": "2022-03",
        "interview1": 0,
        "interview2": 0,
        "interview3": 0
      }
    ]
  }
}

Recruited candidates

GET /api/reports/recruited-candidates

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -3 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Interviews by consultants

GET /api/reports/interviews-by-consultants

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -1 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Top vacancies

GET /api/reports/top-vacancies

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -3 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Requests progress

GET /api/reports/requests-progress

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -3 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Requests progress (created by candidate)

GET /api/reports/requests-by-candidate-progress

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -3 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Requests processing time

GET /api/reports/requests-processing-time

Available GET parameters:

  • dateFrom – string, format YYYY-MM-DD (optional, default -1 month)

  • dateTo – string, format YYYY-MM-DD (optional, default now)

  • businessUnitId – integer (optional)

  • consultantId – integer (optional)

Comments

Leave a Reply

More posts