Skip to main content
GET
/
nessie
/
pipeline
/
status
Get Pipeline
curl --request GET \
  --url https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status \
  --header 'Authorization: Basic <encoded-value>'
import requests

url = "https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Basic <encoded-value>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status")
  .header("Authorization", "Basic <encoded-value>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://{server}.mixpanel.com/api/2.0/nessie/pipeline/status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

response = http.request(request)
puts response.read_body
{
  "canceled": [
    {
      "project_id": 123,
      "name": "<string>",
      "state": "<string>",
      "last_finish": "<string>",
      "run_at": "<string>",
      "from_date": "<string>",
      "to_date": "<string>"
    }
  ],
  "retried": [
    {
      "project_id": 123,
      "name": "<string>",
      "state": "<string>",
      "last_finish": "<string>",
      "run_at": "<string>",
      "from_date": "<string>",
      "to_date": "<string>"
    }
  ],
  "succeeded": [
    {
      "project_id": 123,
      "name": "<string>",
      "state": "<string>",
      "last_finish": "<string>",
      "run_at": "<string>",
      "from_date": "<string>",
      "to_date": "<string>"
    }
  ]
}
{
  "error": "<string>",
  "status": "error"
}
{
  "error": "<string>",
  "status": "error"
}
Given the name of the pipeline this API returns the status of the pipeline. It returns the summary and status of all the recent run export jobs for the pipeline. Example Response: Status with no Summary and a Filter 
curl https://data.mixpanel.com/api/2.0/nessie/pipeline/status \
  -u API_SECRET: \
  -d name="YOUR_PIPELINE_NAME" \
  -d status="running"
Example Response: Status with no Summary and a Filter 
{
  "canceled": [
    {
      "name": "company-july-2016-backfill-hourly-monoschema",
      "state": "canceled",
      "last_finish": "0000-12-31T16:00:00-08:00",
      "run_at": "2016-07-26T00:00:00-07:00",
      "from_date": "2016-07-26T00:00:00-07:00",
      "to_date": "2016-07-26T00:00:00-07:00"
    },
  ]
}

Authorizations

​
Authorization
string
header
required

Service Account

Query Parameters

​
project_id
integer
required

Required if using service account to authenticate request.

​
name
string
required

The name that uniquely identifies the pipeline.

​
summary
string

Default: false. Only lists task count by status and no details.

​
status
string[]

Filters the tasks by the given status. Valid options for status are pending, running, retried, failed, canceled, and timed_out.

Response

Success

​
canceled
object[]
​
retried
object[]
​
succeeded
object[]