This is the reference document for the TestFairy REST API. This API allows the developer to access and interact with TestFairy data remotely.
Getting Started
Getting started with the REST API is easy, and can be done via command line with any programming language. Let's begin with a simple example. We will start by listing all our projects.
A project is either an iOS app or an Android app (two apps with the same package name but on different platforms are considered two projects.)
In the example above, you can see that our user is john@example.com and the API key is 0001234cafecafe. This user authentication token is required for all requests to the REST server.
Your API key is private, please do not share it or post it on public code repositories or forums. To find your API key, please refer to your preferences page.
Get all builds in a project
GET /api/1/projects/{project-id}/builds/
Get all builds in a specific project. Each build is a distinct version that was either uploaded, or created by the TestFairy SDK. Responses STATUS 200 OK
Get session data, events and logs
GET /api/1/projects/{project-id}/builds/{build-id}/sessions/{session-id}/
Get metadata (and optionally data) for a specific session.
parameter
type
description
fields
string
Possible values: "meta", "logs", "events"
Default value: "meta"
Use "events" to load all events, screenshots, touches and other metrices. Use "logs" to fetch
only logs. When loading logs, response will be application/text.