Form Insights

Retrieve Form Insights

get
https://api.typeform.com/insights/{form_id}/summary

Returns form level and individual question level insights for a given form.

Request

Path Parameters

form_id
, required

Unique ID for the form. Find in your form URL. For example, in the URL "https://mysite.typeform.com/to/u6nXL7" the form_id is u6nXL7.

Responses

Status

200 OK

Schema

Provides form level summary and detailed field level insights.

fields Path 3
array of object

Field level insights.

dropoffs
number

Total number of dropoffs at this question.

id
string

The unique ID of the question.

label
string

Label assigned to the question.

ref
string

Unique name assigned to the question.

title
string

Readable name you can use to reference the question.

type
string
Valid values:datedropdownemailfile_uploadgrouplegallong_textmultiple_choicenumberopinion_scalepaymentpicture_choiceratingrankingshort_textstatementwebsiteyes_nophone_number

The type of field.

views
number

Total number of views of this question.

form Path 3
object

Metrics aggregates counters and calculations for the results of a specific form. It provides both aggregates per platform and a global summary.

platforms Path 3
array of object

Platforms specific form insights.

average_time
number

Average completion time in milliseconds.

completion_rate
number

Completion rate. The number represents a percentage.

platform
string
Valid values:desktopotherphonetablet

The name of the platform.

responses_count
number

Total of responses received.

total_visits
number

Total visits to this question.

unique_visits
number

Total unique visits to this question.

summary Path 3
object

Summary of form Insights.

average_time
number

Average completion time in milliseconds.

completion_rate
number

Completion rate. The number represents a percentage.

responses_count
number

Total of responses received.

total_visits
number

Total visits to this question.

unique_visits
number

Total unique visits to this question.

Example

{
  "fields": [
    {
      "dropoffs": 1,
      "id": "aBcDe",
      "label": "4",
      "ref": "060e5675-aaf4-4b53-8be8-de956aae4c69",
      "title": "What is your name?",
      "type": "short_text",
      "views": 15
    }
  ],
  "form": {
    "platforms": [
      {
        "average_time": 56000,
        "completion_rate": 45.5,
        "platform": "desktop",
        "responses_count": 100,
        "total_visits": 15,
        "unique_visits": 2
      }
    ],
    "summary": {
      "average_time": 56000,
      "completion_rate": 45.5,
      "responses_count": 100,
      "total_visits": 15,
      "unique_visits": 2
    }
  }
}

Status

400 Bad request

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

401 Unauthorized

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

403 Forbidden

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

404 Not found

Schema

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description of the error, expanding on the terse code.

details Path 3
array of object

An optional object containing more detailed info regarding which field the error occurred in.

code
string

A developer-readable snake_case key, indicating some idea of what type of error occurred.

description
string

A developer-readable description about the field-level error.

field
string

Which field the error occurred. This could refer to a field in the request body, request header, or query parameter.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

in
string
Valid values:headerbodyquery

The type of field that caused the error.

help
string

A URL linking to help content, to aid the client developer in resolving the error. This value should be provided whenever available.

Status

500 Internal Server Error