curl --request GET \
--url https://api.evermuse.com/api/v1/ingest/batches/{batchId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.evermuse.com/api/v1/ingest/batches/{batchId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.evermuse.com/api/v1/ingest/batches/{batchId}', 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://api.evermuse.com/api/v1/ingest/batches/{batchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://api.evermuse.com/api/v1/ingest/batches/{batchId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.evermuse.com/api/v1/ingest/batches/{batchId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evermuse.com/api/v1/ingest/batches/{batchId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batchId": "<string>",
"status": "LANDING",
"createdAt": 1709282096000,
"acceptedCount": 1,
"rejectedCount": 1,
"totalErrorCount": 1,
"errors": [
{
"index": 1,
"code": "<string>",
"message": "<string>"
}
],
"source": "<string>",
"type": "<string>",
"attachmentDownloadTotal": 1,
"attachmentDownloadComplete": 1,
"attachmentDownloadFailed": 1,
"attachmentDownloadStatus": "PENDING",
"billing": {
"totalCreditsCharged": 1
}
}/ingest/batches/{batchId}
Returns the current status and record counts for a batch you submitted.
Use this to check whether your records have finished processing.
Batch lifecycle
| Status | Meaning |
|---|---|
LANDING | Your data is being saved |
LANDED | Your data is saved and waiting to be processed |
PROCESSING | Your records are being analyzed |
COMPLETE | All records have been processed |
FAILED | Something went wrong (check errors for details) |
curl --request GET \
--url https://api.evermuse.com/api/v1/ingest/batches/{batchId} \
--header 'x-api-key: <api-key>'import requests
url = "https://api.evermuse.com/api/v1/ingest/batches/{batchId}"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.evermuse.com/api/v1/ingest/batches/{batchId}', 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://api.evermuse.com/api/v1/ingest/batches/{batchId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$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://api.evermuse.com/api/v1/ingest/batches/{batchId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.evermuse.com/api/v1/ingest/batches/{batchId}")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.evermuse.com/api/v1/ingest/batches/{batchId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"batchId": "<string>",
"status": "LANDING",
"createdAt": 1709282096000,
"acceptedCount": 1,
"rejectedCount": 1,
"totalErrorCount": 1,
"errors": [
{
"index": 1,
"code": "<string>",
"message": "<string>"
}
],
"source": "<string>",
"type": "<string>",
"attachmentDownloadTotal": 1,
"attachmentDownloadComplete": 1,
"attachmentDownloadFailed": 1,
"attachmentDownloadStatus": "PENDING",
"billing": {
"totalCreditsCharged": 1
}
}Authorizations
Your API key, sent as the x-api-key header.
Create one in Settings > API Keys with api:write permission.
Format: em_sk_...
Path Parameters
The batch ID returned when you sent your records.
128Response
Batch status retrieved successfully.
Unique identifier for this batch.
128Current processing status of the batch. See the batch lifecycle table in the endpoint description.
LANDING, LANDED, PROCESSING, COMPLETE, FAILED When the batch was created, as Unix epoch milliseconds.
1709282096000
Number of records that passed validation.
x >= 0Number of records that failed validation.
x >= 0Total number of validation errors across rejected records.
x >= 0Up to 20 validation errors for quick inspection.
20Show child attributes
Show child attributes
Where the records in this batch came from.
The record type for this batch.
Total number of attachments to be downloaded (shown when the batch includes file attachments).
x >= 0Number of attachments successfully downloaded.
x >= 0Number of attachments that failed to download.
x >= 0Overall download status for the batch's attachments. Only shown when the batch includes file attachments.
PENDING, IN_PROGRESS, COMPLETE, PARTIAL_FAILURE, FAILED Show child attributes
Show child attributes