Available Data

List available data categories for a company.

Returns counts of available data records across different categories for the specified company.

Endpoint

GET /api/v1/companies/:company_id/data

Parameters

Parameter	Type	In	Description
`company_id`	`integer`	path	The unique identifier of the company.

Code Examples

import requests

url = 'https://api.statsnet.co/api/v1/companies/12345/data'
headers = {
  'Authorization': 'Bearer YOUR_API_KEY',
  'Content-Type': 'application/json'
}

response = requests.get(url, headers=headers).json()
print(response)

Response

Success response

{
  "ok": true,
  "bank_accounts_count": 3,
  "stores_count": 0,
  "certs_count": 2,
  "debtors_count": 1,
  "quasi_contracts_count": 0,
  "jobs_count": 5,
  "places_count": 0,
  "states_count": 0,
  "pos_terminals_count": 0,
  "domains_count": 1,
  "scoring_count": 0
}

Field	Type	Description
`bank_accounts_count`	`integer`	Number of bank account records.
`stores_count`	`integer`	Number of store records.
`certs_count`	`integer`	Number of certificate records.
`debtors_count`	`integer`	Number of debtor records.
`quasi_contracts_count`	`integer`	Number of quasi-contract records.
`jobs_count`	`integer`	Number of job posting records.
`places_count`	`integer`	Number of place records.
`states_count`	`integer`	Number of state records.
`pos_terminals_count`	`integer`	Number of POS terminal records.
`domains_count`	`integer`	Number of domain records.
`scoring_count`	`integer`	Number of scoring records.

Error Handling

Error response

{
  "ok": false,
  "error": {
    "code": 403,
    "message": "Forbidden"
  }
}