Sample sources

{
  "sample_sources": [
    {
      "id": 1234,
      "provider": "social_networks",
      "sample_size": 1000,
      "country_code": "FR",
      "description": "Parents aged 30+ with children aged 10-18",
      "name": "Meta - campaign XYZ",
      "hashid": "MBbQN6C7",
      "panelist_id_required": false,
      "created_at": "2025-07-21T10:50:17.725+02:00",
      "updated_at": "2025-07-21T10:50:17.725+02:00"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

List the sample sources

Retrieves all the sample sources of a survey.

GET /api/v1/surveys/{SURVEY_ID}/sample_sources

Parameters

integer

required

The identifier of the survey.

Response fields

integer

ID of the record.

string

Provider type of the sample source. Possible values:

panel
client_sample
social_networks
data_import

integer

Target sample size for this source.

string

ISO 3166 country code, for example: FR.

string

Long description of the sample source.

string

Short description of the sample source.

string

Identifier of the sample source used in URLs.

boolean

Indicates whether the interviews created in this source must have a panelist_id to be valid.

string

Date and time in ISO 8601 format, with time-zone offset.

string

Date and time in ISO 8601 format, with time-zone offset.

{
  "sample_sources": [
    {
      "id": 1234,
      "provider": "social_networks",
      "sample_size": 1000,
      "country_code": "FR",
      "description": "Parents aged 30+ with children aged 10-18",
      "name": "Meta - campaign XYZ",
      "hashid": "MBbQN6C7",
      "panelist_id_required": false,
      "created_at": "2025-07-21T10:50:17.725+02:00",
      "updated_at": "2025-07-21T10:50:17.725+02:00"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

Last modified on August 24, 2026

{
  "sample_sources": [
    {
      "id": 1234,
      "provider": "social_networks",
      "sample_size": 1000,
      "country_code": "FR",
      "description": "Parents aged 30+ with children aged 10-18",
      "name": "Meta - campaign XYZ",
      "hashid": "MBbQN6C7",
      "panelist_id_required": false,
      "created_at": "2025-07-21T10:50:17.725+02:00",
      "updated_at": "2025-07-21T10:50:17.725+02:00"
    }
  ],
  "pagination": {
    "current_page": 1,
    "next_page": null,
    "prev_page": null,
    "total_pages": 1,
    "total_count": 1
  }
}

General information

Endpoints

List the sample sources

Parameters

Response fields

​List the sample sources

​Parameters

​Response fields

List the sample sources

Parameters

Response fields