API za projekte

Projekt je jedan AI intervjuer s vlastitim pitanjima. Većina ostalih krajnjih točaka treba ID projekta, pa je ovo obično prvi poziv koji uputite. Autentifikaciju, straničenje i pogreške opisuje Pregled API-ja.

Popis projekata#

HTTP

GET /api/v1/projects

Vraća sve projekte u organizaciji ključa, od najnovijeg, bili objavljeni ili ne. Ne prima parametre i vraća sve projekte na jednoj stranici.

Primjer#

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

Odgovor#

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
}

Polja projekta#

Polje	Vrsta	Opis
`id`	string	ID projekta
`name`	string ili null	Naziv projekta kako je prikazan na nadzornoj ploči
`product_name`	string ili null	Naziv proizvoda ili usluge iz postavki projekta
`published`	boolean	Je li projekt aktivan
`language`	string ili null	Jezik intervjua, npr. `english`
`respondent_access`	string	`public` (svatko tko ima poveznicu) ili `invite_only`
`url`	string ili null	Javna poveznica za razgovor. Koristi vašu potvrđenu vlastitu domenu ako je imate.
`created_at`	string	Kada je projekt izrađen
`published_at`	string ili null	Kada je zadnji put objavljen

Dohvat projekta#

HTTP

GET /api/v1/projects/{project_id}

Vraća jedan projekt s trenutačnim pitanjima i brojem razgovora.

Primjer#

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

Odgovor#

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
  }
}

Sadrži sva polja s popisa i još:

Polje	Vrsta	Opis
`questions`	array	Objavljena pitanja, po redu
`questions[].id`	string	ID pitanja. Sažeci razgovora navode ga kao `question_id`.
`questions[].text`	string	Pitanje kako je napisano
`questions[].type`	string	`open_text`, `single_choice`, `multiple_choice`, `nps`, `star_rating` ili `file_upload`
`questions[].required`	boolean	Je li pitanje obavezno
`questions[].options`	array	Opcije pitanja s odabirom, svaka s `id` i `label`. Prazno za ostale vrste.
`conversation_counts.total`	number	Razgovori koji su barem otvoreni
`conversation_counts.completed`	number	Razgovori koji su stigli do kraja

Pitanja se s vremenom mogu mijenjati. Sažetak razgovora čuva formulaciju pitanja kakva je stvarno postavljena ispitaniku.