Extracts

Endpointhttps://api.idol.io/api/v2

Asynchronous data export jobs for trends and analytics data.

Workflow:

Create an extract job via POST /extracts with the desired parameters
Poll GET /extracts/{id} to check the job status
When result-url is populated, download the generated file

Supported extract types:

daily-trends - Daily streaming and sales trends data

Output formats:

List extracts

GET

https://api.idol.io/api/v2

/extracts

Retrieve a list of extract jobs

List extracts › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

List extracts › Responses

Successful response

object[]

object

Create an extract

POST

https://api.idol.io/api/v2

/extracts

Create a new extract job to generate a data export file.

The extract is processed asynchronously. Poll GET /extracts/{id} to check the status and retrieve the download URL when ready.

Example: Daily trends extract for a company

Create an extract › Request Body

object · required

Create an extract › Responses

Extract job created and processing

object

POST/extracts

curl --request POST \
  --url https://api.idol.io/api/v2/extracts \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "extracts",
    "attributes": {
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ]
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "extracts",
    "attributes": {
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ]
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "id": "1234",
    "type": "extracts",
    "attributes": {
      "created-at": "2025-12-23T10:24:07.077+01:00",
      "updated-at": "2025-12-23T10:24:07.077+01:00",
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ],
      "result-url": null
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}

json

application/vnd.api+json

Get extract details

GET

https://api.idol.io/api/v2

/extracts/{id}

Retrieve a single extract job by ID.

Poll this endpoint to check the status of an extract job. When the result-url attribute is populated, the file is ready for download.

Get extract details › path Parameters

id

string · required

Resource ID

Get extract details › Responses

Successful response

object

GET/extracts/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/extracts/:id

shell

Example Responses

{
  "data": {
    "id": "1234",
    "type": "extracts",
    "attributes": {
      "created-at": "2025-12-23T10:24:07.077+01:00",
      "updated-at": "2025-12-23T10:30:44.558+01:00",
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ],
      "result-url": "https://storage.example.com/extracts/1234.csv"
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}

json

application/vnd.api+json

Tags Users

Labelcamp API v2

Extracts

Endpointhttps://api.idol.io/api/v2

Asynchronous data export jobs for trends and analytics data.

Workflow:

Create an extract job via POST /extracts with the desired parameters
Poll GET /extracts/{id} to check the job status
When result-url is populated, download the generated file

Supported extract types:

daily-trends - Daily streaming and sales trends data

Output formats:

List extracts

GET

https://api.idol.io/api/v2

/extracts

Retrieve a list of extract jobs

List extracts › query Parameters

page[number]

integer · min: 1

Page number for pagination

Default: 1

page[size]

integer · min: 1 · max: 200

Number of items per page (max 200)

Default: 20

List extracts › Responses

Successful response

object[]

object

Create an extract

POST

https://api.idol.io/api/v2

/extracts

Create a new extract job to generate a data export file.

The extract is processed asynchronously. Poll GET /extracts/{id} to check the status and retrieve the download URL when ready.

Example: Daily trends extract for a company

Create an extract › Request Body

object · required

Create an extract › Responses

Extract job created and processing

object

POST/extracts

curl --request POST \
  --url https://api.idol.io/api/v2/extracts \
  --header 'Content-Type: application/vnd.api+json' \
  --data '
{
  "data": {
    "type": "extracts",
    "attributes": {
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ]
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}
'

shell

Example Request Body

{
  "data": {
    "type": "extracts",
    "attributes": {
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ]
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}

json

application/vnd.api+json

Example Responses

{
  "data": {
    "id": "1234",
    "type": "extracts",
    "attributes": {
      "created-at": "2025-12-23T10:24:07.077+01:00",
      "updated-at": "2025-12-23T10:24:07.077+01:00",
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ],
      "result-url": null
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}

json

application/vnd.api+json

Get extract details

GET

https://api.idol.io/api/v2

/extracts/{id}

Retrieve a single extract job by ID.

Poll this endpoint to check the status of an extract job. When the result-url attribute is populated, the file is ready for download.

Get extract details › path Parameters

id

string · required

Resource ID

Get extract details › Responses

Successful response

object

GET/extracts/{id}

curl --request GET \
  --url https://api.idol.io/api/v2/extracts/:id

shell

Example Responses

{
  "data": {
    "id": "1234",
    "type": "extracts",
    "attributes": {
      "created-at": "2025-12-23T10:24:07.077+01:00",
      "updated-at": "2025-12-23T10:30:44.558+01:00",
      "resource-type": "trends",
      "kind": "daily-trends",
      "filters": {
        "date": "2025-12-10"
      },
      "options": [
        {
          "data": {
            "type": "extract-options",
            "attributes": {
              "name": "format",
              "value": "csv",
              "options": []
            }
          }
        }
      ],
      "result-url": "https://storage.example.com/extracts/1234.csv"
    },
    "relationships": {
      "target": {
        "data": {
          "type": "companies",
          "id": "12345"
        }
      }
    }
  }
}

json

application/vnd.api+json

Tags Users