Skip to main content
GET
Get Brand Summary

Authorizations

api-key
string
header
required

The valid CreatorDB API key for authentication.

Query Parameters

brandId
string
required

Unique brand identifier, typically the brand's primary domain. Allowed characters: letters (a-z, A-Z), digits (0-9), periods (.), underscores (_), and hyphens (-).

Minimum string length: 1
Pattern: ^[a-zA-Z0-9._-]+$
Example:

"acer.com"

Response

200 - application/json

Brand summary data returned successfully.

Response body for a sponsor summary. Summary details are returned in data.

data
object
required

Top-level response object containing the brand summary.

traceId
string
required

Unique trace ID for each request.

Example:

"f8e4a3b2c1d0e9f8a7b6c5d4e3f2a1b0"

timestamp
integer
required

Time the response was generated, represented as a Unix timestamp in milliseconds.

Example:

1750732453635

creditsAvailable
number
required

Remaining credits available for this API key after the current request. Equals planCreditsAvailable plus purchasedCreditsAvailable.

Example:

975

creditsUsed
number
required

Number of API credits consumed by this request.

Example:

25

planCreditsAvailable
number
required

Remaining plan credits after this request, in credits.

Example:

900

purchasedCreditsAvailable
number
required

Remaining purchased-bucket credits after this request, in display units.

Example:

75

errorCode
string
required

Error code returned if the request fails. Empty if the request succeeds.

Example:

""

errorDescription
string
required

Description of the error if any. Empty if successful

Example:

""

success
boolean
required

true if the request is successful.

Example:

true

keyCreditsAvailable
number

Remaining credits this API key can spend after this request, before reaching its spend limit. Present only when the key has a spend limit.

Example:

4975

Last modified on September 10, 2026