🟢API for CSV Export from Dataset

This page contains description how to manage CSV exports via API.

CSV file with raw statistics contains metrics and submetrics as well as other subject and image related data exported as CSV file.

Check CSV export for more details.

What can you do?

Schedule CSV export

Create csv export task for dataset

Create a new csv export task for a dataset

POST/api/v1/companies/{company_id}/datasets/{dataset_id}/csv_exports/

Authorization

Path parameters

company_id*string (uuid)

dataset_id*string (uuid)

Body

task_typeTaskTypeEnum (enum)

full_metrics - Full Metrics
main_metrics - Main Metrics

full_metricsmain_metrics

sincestring,null (date-time)

untilstring,null (date-time)

Response

Body

dataset_id*string (uuid)

dataset_name*string

status*all of

csv_link*string

started_at*string (date-time)

finished_at*string,null (date-time)

task_typeTaskTypeEnum (enum)

full_metrics - Full Metrics
main_metrics - Main Metrics

full_metricsmain_metrics

sincestring,null (date-time)

untilstring,null (date-time)

Request

const response = await fetch('/api/v1/companies/{company_id}/datasets/{dataset_id}/csv_exports/', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer JWT",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "dataset_id": "123e4567-e89b-12d3-a456-426614174000",
  "dataset_name": "text",
  "status": {},
  "csv_link": "text",
  "started_at": "2024-10-22T10:32:37.694Z",
  "task_type": "full_metrics"
}

This method will start the export process. You can check the status of the export with list method.

CSV Export example

"image_id";"image_name";"subject_id";"subject_name";"batch_id";"image_creation_time";"stage";"step";"product_usage";"side";"light";"quality_feedback";"acne-chin-Acne score";"acne-face-Acne score";"acne-forehead-Acne score";"acne-left_cheek-Acne score";"acne-nose-Acne score";"acne-right_cheek-Acne score";"acne-chin-Acne regions density score";"acne-chin-Average intensity of acne regions";"acne-chin-Number of acne regions";"acne-face-Acne regions density score";"acne-face-Average intensity of acne regions";"acne-face-Number of acne regions";"acne-forehead-Acne regions density score";"acne-forehead-Average intensity of acne regions";"acne-forehead-Number of acne regions";"acne-left_cheek-Acne regions density score";"acne-left_cheek-Average intensity of acne regions";"acne-left_cheek-Number of acne regions";"acne-nose-Acne regions density score";"acne-nose-Average intensity of acne regions";"acne-nose-Number of acne regions";"acne-right_cheek-Acne regions density score";"acne-right_cheek-Average intensity of acne regions";"acne-right_cheek-Number of acne regions";"age-face-Perceived Age";"eye_bags-face-Eye Area Condition";"eye_bags-left_eye_area-Eye Area Condition";"eye_bags-right_eye_area-Eye Area Condition";"eye_bags-face-Dark Circle Grade";"eye_bags-face-Dark Circle Score";"eye_bags-face-Eye Bags Grade";"eye_bags-face-Eye Bags Score";"eye_bags-face-Lacrimal Grooves Grade";"eye_bags-face-Lacrimal Grooves Score";"eye_bags-left_eye_area-Dark Circle Grade";"eye_bags-left_eye_area-Dark Circle Score";"eye_bags-left_eye_area-Eye Bags Grade";"eye_bags-left_eye_area-Eye Bags Score";"eye_bags-left_eye_area-Lacrimal Grooves Grade";"eye_bags-left_eye_area-Lacrimal Grooves Score";"eye_bags-right_eye_area-Dark Circle Grade";"eye_bags-right_eye_area-Dark Circle Score";"eye_bags-right_eye_area-Eye Bags Grade";"eye_bags-right_eye_area-Eye Bags Score";"eye_bags-right_eye_area-Lacrimal Grooves Grade";"eye_bags-right_eye_area-Lacrimal Grooves Score";"eyes_age-face-Eye Age";"eyes_age-left_eye_area-Left Eye Age";"eyes_age-right_eye_area-Right Eye Age";"pigmentation-chin-Pigmentation score";"pigmentation-face-Pigmentation score";"pigmentation-forehead-Pigmentation score";"pigmentation-left_cheek-Pigmentation score";"pigmentation-nose-Pigmentation score";"pigmentation-right_cheek-Pigmentation score";"pigmentation-chin-Average intensity of pigmentation";"pigmentation-chin-Average size of pigmentation spots";"pigmentation-chin-Number of pigmentation spots";"pigmentation-chin-Pigmentation density score";"pigmentation-chin-Standard deviation of pigmentation spots size";"pigmentation-face-Average intensity of pigmentation";"pigmentation-face-Average size of pigmentation spots";"pigmentation-face-Number of pigmentation spots";"pigmentation-face-Pigmentation density score";"pigmentation-face-Standard deviation of pigmentation spots size";"pigmentation-forehead-Average intensity of pigmentation";"pigmentation-forehead-Average size of pigmentation spots";"pigmentation-forehead-Number of pigmentation spots";"pigmentation-forehead-Pigmentation density score";"pigmentation-forehead-Standard deviation of pigmentation spots size";"pigmentation-left_cheek-Average intensity of pigmentation";"pigmentation-left_cheek-Average size of pigmentation spots";"pigmentation-left_cheek-Number of pigmentation spots";"pigmentation-left_cheek-Pigmentation density score";"pigmentation-left_cheek-Standard deviation of pigmentation spots size";"pigmentation-nose-Average intensity of pigmentation";"pigmentation-nose-Average size of pigmentation spots";"pigmentation-nose-Number of pigmentation spots";"pigmentation-nose-Pigmentation density score";"pigmentation-nose-Standard deviation of pigmentation spots size";"pigmentation-right_cheek-Average intensity of pigmentation";"pigmentation-right_cheek-Average size of pigmentation spots";"pigmentation-right_cheek-Number of pigmentation spots";"pigmentation-right_cheek-Pigmentation density score";"pigmentation-right_cheek-Standard deviation of pigmentation spots size";"pores-face-Pores Score";"pores-forehead-Pores Score";"pores-left_cheek-Pores Score";"pores-nose-Pores Score";"pores-right_cheek-Pores Score";"pores-face-Pores Density";"pores-face-Pores Number";"quality-face-Image Quality Score";"quality-face-angles_pitch_angle_degree";"quality-face-angles_yaw_angle_degree";"quality-face-colortone_score";"quality-face-eye_height_px";"quality-face-eye_width_px";"quality-face-focus_score";"quality-face-full_face_score";"quality-face-intensity";"quality-face-left_eye_inner_whites_a_channel";"quality-face-left_eye_inner_whites_b_channel";"quality-face-left_eye_inner_whites_l_channel";"quality-face-left_eye_openness";"quality-face-light_direction_score";"quality-face-lightness_score";"quality-face-light_source_azimuth";"quality-face-nose_height_px";"quality-face-occlusion_score";"quality-face-overlap_forehead_skin_mesh_areas_iou";"quality-face-overlap_left_cheek_skin_mesh_areas_iou";"quality-face-overlap_left_eye_inner_skin_mesh_areas_iou";"quality-face-overlap_right_cheek_skin_mesh_areas_iou";"quality-face-overlap_right_eye_inner_skin_mesh_areas_iou";"quality-face-raw_sharpness";"quality-face-resolution_score";"quality-face-right_eye_inner_whites_a_channel";"quality-face-right_eye_inner_whites_b_channel";"quality-face-right_eye_inner_whites_l_channel";"quality-face-right_eye_openness";"quality-face-rotation_score";"quality-face-shadows";"quality-face-shadows_score";"quality-face-shadows_std_a_channel";"quality-face-shadows_std_b_channel";"quality-face-shadows_std_l_channel";"redness-chin-Redness Score";"redness-face-Redness Score";"redness-forehead-Redness Score";"redness-left_cheek-Redness Score";"redness-nose-Redness Score";"redness-right_cheek-Redness Score";"redness-chin-Redness Global Score";"redness-chin-Redness Local Score";"redness-face-Redness Global Score";"redness-face-Redness Local Score";"redness-forehead-Redness Global Score";"redness-forehead-Redness Local Score";"redness-left_cheek-Redness Global Score";"redness-left_cheek-Redness Local Score";"redness-nose-Redness Global Score";"redness-nose-Redness Local Score";"redness-right_cheek-Redness Global Score";"redness-right_cheek-Redness Local Score";"skin_tone-face-ITA score";"skin_tone-forehead-ITA score";"skin_tone-left_cheek-ITA score";"skin_tone-right_cheek-ITA score";"skin_tone-face-SkinTone a channel";"skin_tone-face-SkinTone b channel";"skin_tone-face-SkinTone L channel";"skin_tone-forehead-SkinTone a channel";"skin_tone-forehead-SkinTone b channel";"skin_tone-forehead-SkinTone L channel";"skin_tone-left_cheek-SkinTone a channel";"skin_tone-left_cheek-SkinTone b channel";"skin_tone-left_cheek-SkinTone L channel";"skin_tone-right_cheek-SkinTone a channel";"skin_tone-right_cheek-SkinTone b channel";"skin_tone-right_cheek-SkinTone L channel";"uniformness-face-Uniformness Score";"uniformness-forehead_n_bridge-Uniformness Score";"uniformness-left_cheek-Uniformness Score";"uniformness-right_cheek-Uniformness Score";"translucency-face-Translucency score";"translucency-forehead-Translucency score";"translucency-left_cheek-Translucency score";"translucency-right_cheek-Translucency score";"Hydration-face-Hydration Score";"Hydration-face-Hydration Level";"lines-face-Lines Score";"lines-forehead-Lines Score";"lines-left_cheek-Lines Score";"lines-left_eye_area-Lines Score";"lines-left_eye_corner-Lines Score";"lines-right_cheek-Lines Score";"lines-right_eye_area-Lines Score";"lines-right_eye_corner-Lines Score";"lines-face-Jowls Grade";"lines-face-Sagging Score";"skintone_classification-face-Skin tone";"skin_type-face-Skin type";"skin_type-face-T-zone skin type";"skin_type-face-U-zone skin type";"age_spots-face-Age spots score";"age_spots-forehead-Age spots density";"age_spots-left_cheek-Age spots density";"age_spots-right_cheek-Age spots density";"age_spots-face-Age spots density";"age_spots-face-Age spots grade"
"f22acaa1-793e-4982-8372-091ad4affad9";"demo_image_1.jpg";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"976ba986-03a6-4a55-9da5-88df9144f926";"2024-09-10T10:23:00+00:00";"";"";"";"front";"regular";"Good quality image";"87";"87";"86";"100";"100";"73";"1";"88";"1";"2";"63";"3";"1";"100";"1";"0";"0";"0";"0";"0";"0";"7";"100";"1";"36";"89";"88";"91";"1";"68";"1";"100";"1";"100";"2";"64";"1";"100";"1";"100";"1";"72";"1";"100";"1";"100";"38";"39";"37";"87";"74";"91";"47";"82";"73";"0";"26";"5";"0";"19";"0";"75";"42";"0";"119";"0";"14";"10";"0";"9";"0";"195";"12";"0";"321";"0";"16";"6";"0";"8";"0";"70";"9";"0";"130";"33";"25";"35";"62";"16";"2";"1246";"92";"-4";"2";"100";"99";"294";"78";"100";"97";"0";"1";"";"0";"99";"92";"0";"265";"100";"95";"98";"100";"100";"100";"513";"100";"-1";"0";"";"0";"97";"7";"99";"";"";"";"76";"75";"77";"76";"71";"76";"74";"94";"74";"94";"74";"100";"74";"99";"71";"71";"74";"96";"53";"56";"52";"51";"10";"19";"76";"10";"19";"78";"10";"19";"75";"10";"19";"75";"36";"40";"29";"40";"60";"46";"65";"70";"78";"Normal Hydration";"45";"19";"89";"34";"34";"89";"50";"50";"1";"57";"Light";"Oily";"Oily";"Oily";"";"";"";"";"";""
"b1fc270e-ab66-4762-878c-2dea451d7550";"demo_image_1.jpg";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"67bb78a3-2207-4ef1-8b05-64a348175388";"2024-09-10T10:26:00+00:00";"";"";"";"front";"regular";"Good quality image";"87";"87";"86";"100";"100";"73";"1";"88";"1";"2";"63";"3";"1";"100";"1";"0";"0";"0";"0";"0";"0";"7";"100";"1";"36";"89";"88";"91";"1";"68";"1";"100";"1";"100";"2";"64";"1";"100";"1";"100";"1";"72";"1";"100";"1";"100";"38";"39";"37";"87";"74";"91";"47";"82";"73";"0";"26";"5";"0";"19";"0";"75";"42";"0";"119";"0";"14";"10";"0";"9";"0";"195";"12";"0";"321";"0";"16";"6";"0";"8";"0";"70";"9";"0";"130";"33";"25";"35";"62";"16";"2";"1246";"92";"-4";"2";"100";"99";"294";"78";"100";"97";"0";"1";"";"0";"99";"92";"0";"265";"100";"95";"98";"100";"100";"100";"513";"100";"-1";"0";"";"0";"97";"7";"99";"";"";"";"76";"75";"77";"76";"71";"76";"74";"94";"74";"94";"74";"100";"74";"99";"71";"71";"74";"96";"53";"56";"52";"51";"10";"19";"76";"10";"19";"78";"10";"19";"75";"10";"19";"75";"36";"40";"29";"40";"60";"46";"65";"70";"78";"Normal Hydration";"45";"19";"89";"34";"34";"89";"50";"50";"1";"57";"Light";"Oily";"Oily";"Oily";"";"";"";"";"";""
"f2490668-c623-4a96-bec1-452b062615b6";"demo_image_1.jpg";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"df962819-7962-4f5c-b0d7-1fbfb36f0363";"2024-09-10T10:30:00+00:00";"";"";"";"front";"regular";"Good quality image";"87";"87";"86";"100";"100";"73";"1";"88";"1";"2";"63";"3";"1";"100";"1";"0";"0";"0";"0";"0";"0";"7";"100";"1";"36";"89";"88";"91";"1";"68";"1";"100";"1";"100";"2";"64";"1";"100";"1";"100";"1";"72";"1";"100";"1";"100";"38";"39";"37";"87";"74";"91";"47";"82";"73";"0";"26";"5";"0";"19";"0";"75";"42";"0";"119";"0";"14";"10";"0";"9";"0";"195";"12";"0";"321";"0";"16";"6";"0";"8";"0";"70";"9";"0";"130";"33";"25";"35";"62";"16";"2";"1246";"92";"-4";"2";"100";"99";"294";"78";"100";"97";"0";"1";"";"0";"99";"92";"0";"265";"100";"95";"98";"100";"100";"100";"513";"100";"-1";"0";"";"0";"97";"7";"99";"";"";"";"76";"75";"77";"76";"71";"76";"74";"94";"74";"94";"74";"100";"74";"99";"71";"71";"74";"96";"53";"56";"52";"51";"10";"19";"76";"10";"19";"78";"10";"19";"75";"10";"19";"75";"36";"40";"29";"40";"60";"46";"65";"70";"78";"Normal Hydration";"45";"19";"89";"34";"34";"89";"50";"50";"1";"57";"Light";"Oily";"Oily";"Oily";"68";"6";"32";"12";"9";"5"
"c956be1a-70eb-43d3-94ee-43adf1d85d65";"demo_image_1.jpg";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"0c1215bf-4823-4683-b2ee-72df8bbd8d1d";"2024-09-10T10:33:00+00:00";"";"";"";"front";"regular";"Good quality image";"87";"87";"86";"100";"100";"73";"1";"88";"1";"2";"63";"3";"1";"100";"1";"0";"0";"0";"0";"0";"0";"7";"100";"1";"36";"89";"88";"91";"1";"68";"1";"100";"1";"100";"2";"64";"1";"100";"1";"100";"1";"72";"1";"100";"1";"100";"38";"39";"37";"87";"74";"91";"47";"82";"73";"0";"26";"5";"0";"19";"0";"75";"42";"0";"119";"0";"14";"10";"0";"9";"0";"195";"12";"0";"321";"0";"16";"6";"0";"8";"0";"70";"9";"0";"130";"33";"25";"35";"62";"16";"2";"1246";"92";"-4";"2";"100";"99";"294";"78";"100";"97";"1";"0";"";"0";"99";"92";"0";"265";"100";"95";"98";"100";"100";"100";"513";"100";"-1";"0";"";"0";"97";"7";"99";"";"";"";"76";"75";"77";"76";"71";"76";"74";"94";"74";"94";"74";"100";"74";"99";"71";"71";"74";"96";"53";"56";"52";"51";"10";"19";"76";"10";"19";"78";"10";"19";"75";"10";"19";"75";"36";"40";"29";"40";"60";"46";"65";"70";"78";"Normal Hydration";"45";"19";"89";"34";"34";"89";"50";"50";"1";"57";"Light";"Oily";"Oily";"Oily";"68";"6";"32";"12";"9";"5"
"3a5d0539-8e95-4c85-bc23-8d67ca705416";"demo_image_1.jpg";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"178438b1-2ea2-4b32-8887-9e779f318833";"2024-09-10T10:50:00+00:00";"";"";"";"front";"regular";"Good quality image";"87";"87";"86";"100";"100";"73";"1";"88";"1";"2";"63";"3";"1";"100";"1";"0";"0";"0";"0";"0";"0";"7";"100";"1";"36";"89";"88";"91";"1";"68";"1";"100";"1";"100";"2";"64";"1";"100";"1";"100";"1";"72";"1";"100";"1";"100";"38";"39";"37";"87";"74";"91";"47";"82";"73";"0";"26";"5";"0";"19";"0";"75";"42";"0";"119";"0";"14";"10";"0";"9";"0";"195";"12";"0";"321";"0";"16";"6";"0";"8";"0";"70";"9";"0";"130";"33";"25";"35";"62";"16";"2";"1246";"92";"-4";"2";"100";"99";"294";"78";"100";"97";"0";"1";"";"0";"99";"92";"0";"265";"100";"95";"98";"100";"100";"100";"513";"100";"-1";"0";"";"0";"97";"7";"99";"";"";"";"76";"75";"77";"76";"71";"76";"74";"94";"74";"94";"74";"100";"74";"99";"71";"71";"74";"96";"53";"56";"52";"51";"10";"19";"76";"10";"19";"78";"10";"19";"75";"10";"19";"75";"36";"40";"29";"40";"60";"46";"65";"70";"78";"Normal Hydration";"45";"19";"89";"34";"34";"89";"50";"50";"1";"57";"Light";"Oily";"Oily";"Oily";"68";"6";"32";"12";"9";"5"
"12855985-bff6-4a9b-914c-68b1bf3ba4bf";"Generated: SPF";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"178438b1-2ea2-4b32-8887-9e779f318833";"2024-09-10T08:50:19.446198+00:00";"";"";"";"front";"regular";"Good quality image";"90";"86";"87";"100";"100";"70";"1";"62";"1";"3";"61";"3";"1";"100";"1";"0";"0";"0";"0";"0";"0";"8";"100";"1";"35";"89";"87";"91";"1";"66";"1";"100";"1";"100";"2";"61";"1";"100";"1";"100";"1";"72";"1";"100";"1";"100";"37";"38";"36";"79";"77";"93";"54";"81";"83";"0";"67";"5";"0";"75";"0";"80";"31";"0";"103";"0";"6";"7";"0";"7";"0";"226";"8";"0";"312";"0";"26";"4";"0";"31";"0";"36";"7";"0";"38";"41";"29";"47";"68";"30";"1";"1077";"93";"-3";"2";"100";"95";"292";"83";"100";"101";"1";"0";"";"0";"99";"90";"0";"264";"100";"93";"97";"100";"100";"100";"522";"100";"-1";"0";"";"0";"98";"9";"99";"";"";"";"76";"76";"77";"77";"71";"76";"74";"95";"74";"94";"74";"100";"74";"100";"71";"70";"74";"96";"56";"59";"55";"54";"9";"19";"79";"9";"19";"81";"9";"19";"78";"10";"19";"77";"41";"44";"36";"43";"63";"48";"67";"72";"83";"Normal Hydration";"53";"32";"86";"47";"47";"86";"54";"54";"1";"63";"Light";"Oily";"Oily";"Oily";"75";"3";"29";"9";"7";"4"
"425475ef-2b16-4ca0-b8eb-a72bd906a97c";"Generated: No SPF";"971faed5-15ab-4cd9-847a-bfdd7dd31747";"1";"178438b1-2ea2-4b32-8887-9e779f318833";"2024-09-10T08:50:36.863262+00:00";"";"";"";"front";"regular";"Good quality image";"74";"86";"85";"100";"100";"75";"6";"100";"1";"3";"65";"5";"2";"100";"3";"0";"0";"0";"0";"0";"0";"6";"100";"1";"38";"89";"88";"90";"1";"67";"1";"100";"1";"100";"2";"65";"1";"100";"1";"100";"1";"70";"1";"100";"1";"100";"39";"40";"38";"82";"69";"80";"51";"72";"67";"0";"23";"9";"0";"15";"0";"68";"72";"0";"117";"0";"20";"32";"0";"15";"0";"141";"14";"0";"252";"0";"45";"6";"0";"47";"0";"79";"11";"0";"174";"11";"0";"10";"47";"0";"3";"1658";"93";"-4";"2";"100";"97";"293";"87";"100";"102";"1";"1";"";"0";"99";"89";"0";"264";"100";"94";"95";"100";"100";"100";"533";"100";"-1";"0";"";"0";"97";"11";"99";"";"";"";"73";"71";"73";"72";"66";"72";"71";"84";"70";"82";"71";"90";"71";"87";"67";"56";"71";"86";"50";"53";"49";"48";"12";"19";"74";"11";"19";"76";"12";"19";"73";"12";"19";"73";"7";"5";"5";"13";"58";"45";"62";"68";"70";"Mild Dehydration";"44";"14";"88";"41";"41";"88";"54";"54";"2";"54";"Light";"Oily";"Oily";"Oily";"63";"9";"43";"9";"9";"6"

List your CSV exports

List csv export tasks for dataset

List all csv export tasks for a dataset. Latest tasks are shown first by default.

GET/api/v1/companies/{company_id}/datasets/{dataset_id}/csv_exports/

Authorization

Path parameters

company_id*string (uuid)

dataset_id*string (uuid)

Query parameters

Response

Body

count*integer

Example: 123

nextnullable string (uri)

Example: "http://api.example.org/accounts/?page=4"

previousnullable string (uri)

Example: "http://api.example.org/accounts/?page=2"

results*array of CSVTask (object)

Request

const response = await fetch('/api/v1/companies/{company_id}/datasets/{dataset_id}/csv_exports/', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "dataset_id": "123e4567-e89b-12d3-a456-426614174000",
      "dataset_name": "text",
      "status": {},
      "csv_link": "text",
      "started_at": "2024-10-22T10:32:37.694Z",
      "task_type": "full_metrics"
    }
  ]
}

When the export is ready (has status done), you can download it using the csv_link field to download the file.

PreviousAPI for Datasets NextAPI for Algorithm Applications

Last updated 3 days ago