Skip to content
/
Resume Batch Enrichment

Core API Concepts (1.0.0)

Discovery

Identify and evaluate creators using structured, platform-specific search criteria. Responses are intentionally constrained to support ranking, filtering, and selection at scale rather than full profile hydration.

Enrichment

Retrieve complete creator-level data once a candidate has been identified. Enrichment responses provide the depth required for analysis, activation, and downstream data workflows.

Execution modes

Enrichment is available in both synchronous and asynchronous forms. Single enrichment supports real-time use cases, while batch enrichment is optimized for high-throughput, non-interactive processing.

Typical usage

Discovery and enrichment are designed as complementary stages. Discovery narrows the candidate set; enrichment supplies detailed data for creators that have already been qualified.

Languages
Servers
Production
https://api-dashboard.influencers.club

Discovery API

Operations

Similar Creators

Operations

Dictionary

Provides the complete set of supported filter values used by the Discovery and Similar Creators endpoints.

These endpoints return all valid, platform-specific values (such as languages, locations, brands, YouTube topics, and Twitch games) that can be used when constructing discovery queries.

Clients should retrieve dictionary values programmatically to ensure only supported values are sent in requests. Available values may vary by platform and can evolve over time.

Operations

Enrich by handle full

Operations

Enrich by handle raw

Operations

Enrich by email advanced

Operations

Enrich by email basic

Operations

Batch enrichment

Bulk enrichment jobs: create, check status, resume, and download results.

Operations

Download Batch Enrichment Results

Request

Download the results for a completed batch enrichment job.

When to use

  • After the batch reaches a completed state in the status endpoint

Credits

  • 0 credits (download only)
Security
Bearer
Path
batch_idstringrequired

Unique batch identifier returned when creating the enrichment batch

Headers
Authorizationstringrequired

Bearer << Client JWT Token >>

curl -i -X GET \
  'https://api-dashboard.influencers.club/public/v1/enrichment/batch/{batch_id}/' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

CSV file with enriched results

Bodyapplication/json
string(binary)
Response
application/json
"string"

Resume Batch Enrichment

Request

Resume a paused or interrupted batch enrichment job.

When to use

  • If a batch was paused or failed mid-run and needs to continue processing

Credits

  • 0 credits to resume (credits apply only to successfully enriched records)
Security
Bearer
Path
batch_idstringrequired

Unique batch identifier returned when creating the enrichment batch

Headers
Authorizationstringrequired

Bearer << Client JWT Token >>

curl -i -X POST \
  'https://api-dashboard.influencers.club/public/v1/enrichment/batch/{batch_id}/resume/' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Batch resumed successfully

Bodyapplication/json
property name*anyadditional property
Response
application/json
{
  "property1": null,
  "property2": null
}

Get Batch Enrichment Status

Request

Check the current processing status of a batch enrichment job.

What you get

  • Current state (e.g., queued/running/completed/failed)
  • Progress indicators (processed vs remaining), when available

Credits

  • 0 credits (status only)
Security
Bearer
Path
batch_idstringrequired

Unique batch identifier returned when creating the enrichment batch

Headers
Authorizationstringrequired

Bearer << Client JWT Token >>

curl -i -X GET \
  'https://api-dashboard.influencers.club/public/v1/enrichment/batch/{batch_id}/status/' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json
batch_idstringrequired

Unique identifier for the batch enrichment job

statusstringrequired

Current status of the batch job (processing, finished, failed, queued, paused_insufficient_credits)

total_rowsintegerrequired

Total number of records submitted in the batch

processed_rowsintegerrequired

Total number of records that have finished processing

success_countintegerrequired

Number of records processed successfully

failed_countintegerrequired

Number of records that failed or could not be processed

started_atstring(date-time)required

Timestamp when the batch was created

metadataobjectrequired

Metadata provided with the batch

metadata.​property name*anyadditional property
credits_usedstring(decimal)^-?\d{0,8}(?:\.\d{0,2})?$required

Total number of credits used in the batch

estimated_completionstring or null(date-time)required

Estimated completion timestamp based on current progress (null if unavailable)

status_messagestring or null

Human-readable message about the batch status (only present when paused)

Response
application/json
{
  "batch_id": "string",
  "status": "string",
  "total_rows": 0,
  "processed_rows": 0,
  "success_count": 0,
  "failed_count": 0,
  "started_at": "2019-08-24T14:15:22Z",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "credits_used": "string",
  "estimated_completion": "2019-08-24T14:15:22Z",
  "status_message": "string"
}

Post Details

Operations

Account credits & usage

Account-level endpoints (credits, usage).

Operations