Get Takedown Success Rate

Get organization takedown success rate by asset type

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "slug": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "blockLabel": "<string>",
  "countryCodes": [
    "<string>"
  ],
  "brandIds": [
    1
  ]
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate"

payload = {
    "slug": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "blockLabel": "<string>",
    "countryCodes": ["<string>"],
    "brandIds": [1]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    slug: '<string>',
    startDate: '<string>',
    endDate: '<string>',
    blockLabel: '<string>',
    countryCodes: ['<string>'],
    brandIds: [1]
  })
};

fetch('https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate', 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://app.chainpatrol.io/api/v2/metrics/takedown-success-rate",
  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([
    'slug' => '<string>',
    'startDate' => '<string>',
    'endDate' => '<string>',
    'blockLabel' => '<string>',
    'countryCodes' => [
        '<string>'
    ],
    'brandIds' => [
        1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate"

	payload := strings.NewReader("{\n  \"slug\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"blockLabel\": \"<string>\",\n  \"countryCodes\": [\n    \"<string>\"\n  ],\n  \"brandIds\": [\n    1\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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://app.chainpatrol.io/api/v2/metrics/takedown-success-rate")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"slug\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"blockLabel\": \"<string>\",\n  \"countryCodes\": [\n    \"<string>\"\n  ],\n  \"brandIds\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slug\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"blockLabel\": \"<string>\",\n  \"countryCodes\": [\n    \"<string>\"\n  ],\n  \"brandIds\": [\n    1\n  ]\n}"

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

{
  "byAssetType": [
    {
      "assetType": "URL",
      "submitted": 123,
      "completed": 123,
      "stillOpen": 123,
      "successRate": 123,
      "resolvedSuccessRate": 123
    }
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

POST

metrics

takedown-success-rate

Get organization takedown success rate by asset type

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "slug": "<string>",
  "startDate": "<string>",
  "endDate": "<string>",
  "blockLabel": "<string>",
  "countryCodes": [
    "<string>"
  ],
  "brandIds": [
    1
  ]
}
'

import requests

url = "https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate"

payload = {
    "slug": "<string>",
    "startDate": "<string>",
    "endDate": "<string>",
    "blockLabel": "<string>",
    "countryCodes": ["<string>"],
    "brandIds": [1]
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    slug: '<string>',
    startDate: '<string>',
    endDate: '<string>',
    blockLabel: '<string>',
    countryCodes: ['<string>'],
    brandIds: [1]
  })
};

fetch('https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate', 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://app.chainpatrol.io/api/v2/metrics/takedown-success-rate",
  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([
    'slug' => '<string>',
    'startDate' => '<string>',
    'endDate' => '<string>',
    'blockLabel' => '<string>',
    'countryCodes' => [
        '<string>'
    ],
    'brandIds' => [
        1
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate"

	payload := strings.NewReader("{\n  \"slug\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"blockLabel\": \"<string>\",\n  \"countryCodes\": [\n    \"<string>\"\n  ],\n  \"brandIds\": [\n    1\n  ]\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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://app.chainpatrol.io/api/v2/metrics/takedown-success-rate")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"slug\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"blockLabel\": \"<string>\",\n  \"countryCodes\": [\n    \"<string>\"\n  ],\n  \"brandIds\": [\n    1\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"slug\": \"<string>\",\n  \"startDate\": \"<string>\",\n  \"endDate\": \"<string>\",\n  \"blockLabel\": \"<string>\",\n  \"countryCodes\": [\n    \"<string>\"\n  ],\n  \"brandIds\": [\n    1\n  ]\n}"

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

{
  "byAssetType": [
    {
      "assetType": "URL",
      "submitted": 123,
      "completed": 123,
      "stillOpen": 123,
      "successRate": 123,
      "resolvedSuccessRate": 123
    }
  ]
}

{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}

{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}

{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}

{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

Overview

Get the share of takedowns that ended in a removal, per asset type, for takedowns first filed with a provider in a date range.

This endpoint is gated behind the takedown-success-rate feature flag on a per-organization basis. If the flag is not enabled for your organization, the API returns a 403 Forbidden error. Contact ChainPatrol to enable access.

curl --request POST \
  --url https://app.chainpatrol.io/api/v2/metrics/takedown-success-rate \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '{
    "slug": "your-org",
    "startDate": "2026-08-01",
    "endDate": "2026-09-30"
  }'

Request Body

Field	Type	Required	Description
`slug`	`string`	✅ Yes	Organization slug.
`startDate`	`string`	❌ No	Only takedowns first filed on or after this date. A date-only value (`YYYY-MM-DD`) starts at midnight UTC.
`endDate`	`string`	❌ No	Only takedowns first filed on or before this date. A date-only value covers the whole day in UTC.
`brandIds`	`number[]`	❌ No	Only assets belonging to these brands.
`brandType`	`string`	❌ No	Only brands of this type: `INDIVIDUAL`, `ORGANIZATION` or `PRODUCT`.
`blockLabel`	`string`	❌ No	Only assets blocked with this review label, such as `Brand Impersonation`.
`countryCodes`	`string[]`	❌ No	Only assets scanned from these ISO 3166-1 alpha-2 countries.

Reading the response

byAssetType has one entry per asset type, most takedowns first:

Field	Description
`submitted`	Takedowns first filed with a provider in the range. Takedowns opened but never filed are not counted.
`completed`	Of those, how many ended in a removal.
`stillOpen`	Of those, how many have no outcome yet.
`successRate`	`completed / submitted`, from 0 to 1. Takedowns still being worked count against it.
`resolvedSuccessRate`	`completed / (submitted - stillOpen)`, from 0 to 1, or `null` when none has an outcome yet.

Outcomes are read as of now, so a recent range has more takedowns still open and a lower successRate. Compare resolvedSuccessRate when you want the rate among takedowns that have finished.

Authorizations

X-API-KEY

string

header

required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json

slug

string

required

Organization slug

Minimum string length: 1

startDate

string

Only include takedowns first submitted to a provider on or after this date. A date-only value (YYYY-MM-DD) starts at midnight UTC

endDate

string

Only include takedowns first submitted to a provider on or before this date. A date-only value (YYYY-MM-DD) covers the whole day in UTC; pass a full timestamp for a precise cut-off

blockLabel

string

Only include assets blocked with this review label, e.g. "Brand Impersonation", "Employee Impersonation" or "Targeting Org Users"

brandType

enum<string>

Only include assets belonging to brands of this type

Available options:

INDIVIDUAL,

ORGANIZATION,

PRODUCT

countryCodes

string[]

Only include assets scanned from these ISO 3166-1 alpha-2 countries

Required string length: 2

brandIds

integer[]

Only include assets belonging to these brands

Required range: x > 0

Response

Successful response

byAssetType

object[]

required

Takedown success rate, one entry per asset type, descending by number submitted

Show child attributes

Getting Started

Assets

Reports

Disputes

Webhooks

Organization Brands

Organization Assets

Organization Asset Groups

Organization Reports

Threat Detection

Dark Web

Takedowns

Metrics

Account & Access

Operations

Staff

Healthchecks

Get Takedown Success Rate

Overview

Request Body

Reading the response

Authorizations

Body

Response

​Overview

​Request Body

​Reading the response

Authorizations

Body

Response

Overview

Request Body

Reading the response