Create measurement job

One async ingest resource. source:"current" captures present counts via the snapshot pipeline. source:"historical" enqueues each resolved recording for Songstats deep backfill ranked by all-time streams (idempotent — songs already carrying songstats history are skipped; no track is fetched twice). Provide exactly one of catalog_id / album_ids / isrcs in scope. The returned id is a snapshot id you can pass to Create catalog to materialize the measured tracks into an account-owned catalog.

POST /api/research/measurement-jobs

Create a measurement job

cURL

curl --request POST \
  --url https://api.recoupable.com/api/research/measurement-jobs \
  --header 'Content-Type: application/json' \
  --data '
{
  "scope": {
    "catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "album_ids": [
      "<string>"
    ],
    "isrcs": [
      "<string>"
    ]
  },
  "platforms": [
    "spotify"
  ]
}
'

import requests

url = "https://api.recoupable.com/api/research/measurement-jobs"

payload = {
    "scope": {
        "catalog_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "album_ids": ["<string>"],
        "isrcs": ["<string>"]
    },
    "platforms": ["spotify"]
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    scope: {
      catalog_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
      album_ids: ['<string>'],
      isrcs: ['<string>']
    },
    platforms: ['spotify']
  })
};

fetch('https://api.recoupable.com/api/research/measurement-jobs', 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.recoupable.com/api/research/measurement-jobs",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'scope' => [
        'catalog_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        'album_ids' => [
                '<string>'
        ],
        'isrcs' => [
                '<string>'
        ]
    ],
    'platforms' => [
        'spotify'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.recoupable.com/api/research/measurement-jobs"

	payload := strings.NewReader("{\n  \"scope\": {\n    \"catalog_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"album_ids\": [\n      \"<string>\"\n    ],\n    \"isrcs\": [\n      \"<string>\"\n    ]\n  },\n  \"platforms\": [\n    \"spotify\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.recoupable.com/api/research/measurement-jobs")
  .header("Content-Type", "application/json")
  .body("{\n  \"scope\": {\n    \"catalog_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"album_ids\": [\n      \"<string>\"\n    ],\n    \"isrcs\": [\n      \"<string>\"\n    ]\n  },\n  \"platforms\": [\n    \"spotify\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.recoupable.com/api/research/measurement-jobs")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scope\": {\n    \"catalog_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n    \"album_ids\": [\n      \"<string>\"\n    ],\n    \"isrcs\": [\n      \"<string>\"\n    ]\n  },\n  \"platforms\": [\n    \"spotify\"\n  ]\n}"

response = http.request(request)
puts response.read_body

202

{
  "status": "success",
  "source": "historical",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "state": "queued",
  "enqueued": 842,
  "skipped": 3,
  "album_count": 123,
  "estimated_cost_usd": 123
}

{
  "status": "error",
  "error": "Missing required parameter: artist"
}

{
  "status": "error",
  "error": "Missing required parameter: artist"
}

{
  "status": "error",
  "error": "Missing required parameter: artist"
}

Body

application/json

scope · object · required

Provide exactly one of catalog_id, album_ids, or isrcs.

Show child attributes

source · enum<string> · required

current = capture present counts (Apify snapshot). historical = enqueue Songstats deep backfill.

Available options: current, historical

platforms · string[]

Example:

["spotify"]

Response

202

application/json

Job accepted.

For current jobs, id is pollable. For historical jobs, enqueued/skipped summarize the backfill enqueue (the queue drains via the daily worker).

status · string

Example:

"success"

source · string

Example:

"historical"

id · string<uuid> | null

Job id for current jobs; null for historical.

state · enum<string> | null

Available options: queued

Example:

"queued"

enqueued · integer | null

historical: recordings enqueued for backfill.

Example:

842

skipped · integer | null

historical: recordings already backfilled (skipped).

Example:

3

album_count · integer | null

current: albums the job will capture.

estimated_cost_usd · number | null

current: scraper cost estimate before spend.