Skip to main content
GET
/
apps
/
portal
/
data
/
users
Get user data from Telegram DB and ELK via PortalService
curl --request GET \
  --url https://api.provident.ae/v2/apps/portal/data/users \
  --header 'Authorization: Bearer <token>'
{
  "message": "User data retrieved successfully",
  "data": {
    "bitrix_id": 12345,
    "source_table": "users",
    "owner_searches": {
      "successful": 45,
      "unsuccessful": 5,
      "total": 50
    },
    "unit_searches": {
      "successful": 100,
      "unsuccessful": 50,
      "total": 150
    },
    "total_searches": 200,
    "areas_searched_vs_assigned": "10 / 25",
    "elk_error": null
  },
  "timestamp": "2025-09-26T06:22:33.037Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
bitrix_id
number

Bitrix ID (required for manual runs)

​
startDate
string

Start date (YYYY-MM-DD)

​
endDate
string

End date (YYYY-MM-DD)

​
automated_run
boolean

Flag for automated daily run. If true, run_date is required.

​
run_date
string

Date for automated run (YYYY-MM-DD).

Response

User data retrieved successfully

​
message
string
Example:

"User data retrieved successfully"

​
data
object
Example:
{
  "bitrix_id": 12345,
  "source_table": "users",
  "owner_searches": {
    "successful": 45,
    "unsuccessful": 5,
    "total": 50
  },
  "unit_searches": {
    "successful": 100,
    "unsuccessful": 50,
    "total": 150
  },
  "total_searches": 200,
  "areas_searched_vs_assigned": "10 / 25",
  "elk_error": null
}
​
timestamp
string<date-time>
Example:

"2025-09-26T06:22:33.037Z"