Company Stats

Retrieve company statistics

get

Fetches various statistics related to the specified company, such as leads, scans, contacts saved, profiles, devices, and top performers.

Query parameters

company_idintegerRequired

The ID of the company for which to retrieve statistics.

Example: 385

startintegerOptional

Start of the date range filter (Unix timestamp).

Example: 1700000000

endintegerOptional

End of the date range filter (Unix timestamp).

Example: 1723185083

profile_idintegerOptional

The ID of the profile to filter statistics by.

Example: 21312

Responses

200

A successful response with the company statistics.

application/json

get

/company/stats

HTTPcURLJavaScriptPython

GET /company/stats?company_id=385 HTTP/1.1
Host: api.taag.co
Accept: */*

200

A successful response with the company statistics.

{
  "status": "success",
  "stats": {
    "leads": [
      {
        "x": "2024-08-09",
        "y": 6
      }
    ],
    "scans": [
      {
        "x": "2024-08-09",
        "y": 5
      }
    ],
    "contacts_saved": [
      {
        "x": "2024-08-09",
        "y": 1
      }
    ],
    "profiles": [
      {
        "x": "2024-08-14",
        "y": 9
      }
    ],
    "devices": [
      {
        "x": "2024-07-31",
        "y": 2
      }
    ],
    "top_devices": [
      {
        "device_id": 123,
        "scans": 101,
        "profile_name": "Phillip Musiime",
        "profile_image": "https://picsum.photos/200",
        "device_name": "Taag | Phillip Musiime"
      }
    ],
    "top_links": [
      {
        "key": "pdf",
        "value": "https://mytaagbucket.s3.eu-central-1.amazonaws.com/user-files/17131640630zT7wUZb9BZLjHSgIIwZN7CsbV96rd/Phillip%20Musiime.pdf",
        "icon_url": "",
        "link_clicks": 4
      }
    ],
    "top_performers": [
      {
        "profile_id": 22,
        "profile_name": "Phillip Musiime",
        "views": 73,
        "leads": 15
      }
    ]
  }
}