Get credit metrics | Dealsignal

Returns the authenticated account’s identity, remaining subscription credits, and today’s profile-request metrics in a single JSON object. Read-only: it creates nothing and does not consume credits.

daily_profile_request_metrics counts Contact Profile Refresh profiles created on the current server date. Profiles of a synchronous request that were matched and already completed in the create response are usually left out; test requests are never counted, and the counts start again at the next server-day boundary.

Send Accept: application/json from API clients so that authentication errors come back as JSON. The same applies to every endpoint.

Query parameters

api_keystringRequired

Your Dealsignal API key. Obtain it from the Dealsignal dashboard.

Response

Credit metrics for the account.

emailstringOptionalformat: "email"

namestringOptional

usernamestringOptional

current_subscription_dataobjectOptional

daily_profile_request_metricsobjectOptional

Counts of Contact Profile Refresh profiles (rows, not requests) submitted today — the current server date. Profiles of a synchronous request that were matched and already completed in the create response are usually not counted; every other profile is, including profiles closed at creation without a match (contact_data.id null) and every profile of an asynchronous request. Requests submitted with test: true are excluded. requested = requested_with_ds_contact_id + requested_without_ds_contact_id.

Errors

401

Unauthorized Error