Contact Enrichment Usage Stats

POST 
/v1/enrich/usageStats

Provides usage statistics for API calls to the contact enrichment endpoints.

Request Body

Field	Type	Description	Required
start_date	string	Beginning date (inclusive) of usage period to check, in YYYY-MM-DD format.	✅ Yes
start_date	string	Ending date (inclusive) of usage period to check, in YYYY-MM-DD format, defaults to current date.	❌ No

---

Example Request (JSON)

{
    "start_date": "2025-01-01",
    "end_date": "2025-01-31"
}

---

Response

The response returns a list of endpoint usage statistics for each endpoint.

Example Success Response

{
  "endpoint_usage": [
    {
      "endpoint": "EnrichContact",
      "total_requests": 120,
      "successful_requests": 105,
      "failed_requests": 15
    },
    {
      "endpoint": "ContactExistence",
      "total_requests": 85,
      "successful_requests": 80,
      "failed_requests": 5
    }
  ]
}

---

Error Handling

The API returns appropriate error messages with status codes if something goes wrong.

Error Code	Message	Description
400	Invalid Request	Start date is required
401	Unauthorized	Verify you are using a valid API key
500	Internal Server Error	An unexpected error occurred.

Example Error Response

{
  "error": {
    "code": 400,
    "message":"Start date is required"
  }
}

Request

Responses

200

Successful response