Skip to main content

Overview

The Data Export endpoint provides structured access to Euka platform data across six export types. Responses are available in both JSON and CSV formats and can be integrated directly into reporting pipelines, BI tools, or custom dashboards. Base URL
GET https://app.euka.ai/api/data-export

Query Parameters

type
string
required
Specifies the category of data to export. Must be one of the values listed in the Export Types section below.
store_id
string
required
The UUID of your Euka store. Contact your account manager or Euka support if you do not have this value.Example: c84f8336-a7e3-4f77-831b-91757cdb2cf5
start_date
string
The start of the date range in YYYY-MM-DD format. Required for most export types. The maximum supported range is 60 days.Example: 2025-06-01
end_date
string
The end of the date range in YYYY-MM-DD format.Example: 2025-07-01
export_type
string
default:"json"
The format of the exported data. Accepted values: json or csv.CSV responses are returned as a downloadable file attachment. JSON responses are returned inline in the response body.
creator_handle
string
The username of the creator. Required when type is set to creator_video_level.Example: example_creator

Export Types

TypeDescriptionDates RequiredAdditional Parameters
sample_requestsSample request data with status breakdown
target_collab_invitesTarget collaboration invites
creator_videosCreator video data with performance metrics
creator_levelAggregated creator-level data
creator_video_levelDetailed video-level data for a specific creatorcreator_handle
bot_levelCampaign-level data with creator reach and counts
start_date and end_date are required for sample_requests, target_collab_invites, creator_videos, and creator_video_level. They are not required for creator_level or bot_level.

Request Examples

curl "https://app.euka.ai/api/data-export?type=sample_requests&store_id=<store_id>&start_date=2025-06-01&end_date=2025-07-01&export_type=json"

Response Formats

JSON responses are returned inline in the response body.
{
  "message": "data-export:: Data exported successfully",
  "data": [...],
  "count": 150,
  "type": "sample_requests",
  "store_id": "c84f8336-a7e3-4f77-831b-91757cdb2cf5",
  "start_date": "2025-06-01",
  "end_date": "2025-07-01",
  "export_type": "json"
}

Data Fields

FieldDescription
sample_idUnique application identifier
creator_handleCreator’s username
creator_last_30d_gmv_numCreator’s gross merchandise value over the last 30 days
product_idAssociated product identifier
statusCurrent request status
created_atTimestamp when the request was created
shipped_timeTimestamp when the sample was shipped
last_updated_atTimestamp of the most recent update
commission_rateApplicable commission rate
approve_expiration_timeDeadline for approval
Core Campaign Information
FieldDescription
bot_idUnique campaign identifier
bot_linkDirect link to the campaign in the Euka dashboard
campaign_nameName of the campaign
message_typeCampaign type (e.g. target_collab, message)
creators_reachedTotal number of creators successfully contacted
sample_requestsTotal number of sample requests received
remaining_creatorsNumber of creators not yet contacted
bot_statusCurrent campaign status (running or stopped)
created_dateDate the campaign was created
daily_limitMaximum number of outreach actions per day
error_messageError details, if applicable
last_updated_atTimestamp of the most recent update
Targeting Configuration
FieldDescription
targeting_methodTargeting strategy used (filters, list, or segment)
target_agesTarget audience age ranges
target_avg_viewsTarget average view count ranges
target_categoriesTarget product categories
target_creator_genderTarget creator gender
target_creator_languagesTarget creator languages
target_follower_countsTarget follower count ranges
target_genderTarget audience gender
target_gmvsTarget GMV ranges
target_avg_live_viewsTarget average live view ranges
target_avg_shoppable_video_viewsTarget average shoppable video view ranges
target_engagement_rateTarget engagement rate threshold
use_segment_min_timeWhether segment minimum time filtering is enabled
Campaign Details
FieldDescription
productsProducts associated with the campaign
creator_list_idsCreator list IDs used for targeting
group_idSegment group identifier
send_to_allWhether the campaign targets all eligible creators
target_collab_messageOutreach message sent to creators
target_collab_invitation_nameName of the collaboration invitation
target_collab_email_addressContact email address for the campaign
target_collab_free_samplesWhether free samples are offered
target_collab_manually_review_sample_requestsWhether sample requests require manual review
sample_request_status_breakdownPer-status breakdown of all sample requests

Error Reference

Returned when one or more required parameters are missing or invalid.
{
  "error": {
    "statusCode": 400,
    "message": "data-export:: Missing required parameters: type, store_id"
  }
}
Returned when a non-GET HTTP method is used. Only GET requests are supported.
{
  "error": {
    "statusCode": 405,
    "message": "data-export:: Method not allowed"
  }
}
Returned when an unexpected server-side error occurs. The message field will include additional context where available.
{
  "error": {
    "statusCode": 500,
    "message": "data-export:: [error details]"
  }
}

Constraints & Limits

ConstraintValue
Supported HTTP methodGET only
Maximum date range60 days
Maximum request duration300 seconds (5 minutes)
Supported export formatsjson, csv
Large exports may take several minutes to complete. For very large datasets, consider narrowing the date range or exporting in multiple smaller batches.