Projekti-API

Projekti on yksi AI-haastattelija omine kysymyksineen. Useimmat muut päätepisteet tarvitsevat projektin ID:n, joten tämä on yleensä ensimmäinen pyyntösi. Katso todennus, sivutus ja virheet sivulta API:n yleiskatsaus.

Listaa projektit#

HTTP

GET /api/v1/projects

Palauttaa avaimen organisaation kaikki projektit uusin ensin, olivatpa ne julkaistuja tai eivät. Se ei ota parametreja ja palauttaa kaikki projektit yhdellä sivulla.

Esimerkki#

curl "https://diaform.io/api/v1/projects" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Vastaus#

JSON

{
  "data": [
    {
      "id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "name": "Onboarding interviews",
      "product_name": "Acme",
      "published": true,
      "language": "english",
      "respondent_access": "public",
      "url": "https://acme.diaform.io/c/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
      "created_at": "2026-04-02T09:14:31.402057+00:00",
      "published_at": "2026-04-02T09:41:05.471073+00:00"
    }
  ],
  "has_more": false,
  "next_cursor": null
}

Projektin kentät#

Kenttä	Tyyppi	Kuvaus
`id`	string	Projektin ID
`name`	string tai null	Projektin nimi sellaisena kuin se näkyy hallintapaneelissa
`product_name`	string tai null	Tuotteen tai palvelun nimi projektin asetuksista
`published`	boolean	Onko projekti julkaistu
`language`	string tai null	Haastattelun kieli, esimerkiksi `english`
`respondent_access`	string	`public` (kuka tahansa, jolla on linkki) tai `invite_only`
`url`	string tai null	Julkinen keskustelulinkki. Se käyttää vahvistettua omaa verkkotunnustasi, jos sinulla on sellainen.
`created_at`	string	Milloin projekti luotiin
`published_at`	string tai null	Milloin se viimeksi julkaistiin

Hae projekti#

HTTP

GET /api/v1/projects/{project_id}

Palauttaa yhden projektin sekä sen nykyiset kysymykset ja keskustelumäärät.

Esimerkki#

curl "https://diaform.io/api/v1/projects/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d" \
  -H "Authorization: Bearer $DIAFORM_API_KEY"

Vastaus#

JSON

{
  "id": "b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "name": "Onboarding interviews",
  "product_name": "Acme",
  "published": true,
  "language": "english",
  "respondent_access": "public",
  "url": "https://acme.diaform.io/c/b8acb3ab-1f3d-4a7e-a846-b7f493f86b6d",
  "created_at": "2026-04-02T09:14:31.402057+00:00",
  "published_at": "2026-04-02T09:41:05.471073+00:00",
  "questions": [
    {
      "id": "V1StGXR8_Z5jdHi6B-myT",
      "text": "How did your first week with the product go?",
      "type": "open_text",
      "required": false,
      "options": []
    },
    {
      "id": "tTJUuhijB3m3nvA5horJ6",
      "text": "Which plan are you on?",
      "type": "single_choice",
      "required": true,
      "options": [
        { "id": "fvbfMZcZXZLzZWCa-jXXJ", "label": "Starter" },
        { "id": "nb-XqVVvSICqEQjZ12Mox", "label": "Pro" }
      ]
    }
  ],
  "conversation_counts": {
    "total": 212,
    "completed": 148
  }
}

Siinä on kaikki listan kentät ja lisäksi:

Kenttä	Tyyppi	Kuvaus
`questions`	array	Julkaistut kysymykset järjestyksessä
`questions[].id`	string	Kysymyksen ID. Keskustelujen yhteenvedot viittaavat siihen nimellä `question_id`.
`questions[].text`	string	Kysymys sellaisena kuin se on kirjoitettu
`questions[].type`	string	`open_text`, `single_choice`, `multiple_choice`, `nps`, `star_rating` tai `file_upload`
`questions[].required`	boolean	Onko kysymys pakollinen
`questions[].options`	array	Valintakysymyksen vaihtoehdot, kullakin `id` ja `label`. Tyhjä muissa tyypeissä.
`conversation_counts.total`	number	Keskustelut, jotka on vähintään avattu
`conversation_counts.completed`	number	Keskustelut, jotka etenivät loppuun asti

Kysymykset voivat muuttua ajan myötä. Keskustelun yhteenvedossa säilyy se sanamuoto, jolla kysymys vastaajalle oikeasti esitettiin.