Report Search

POSThttps://api.deepinfo.com/v1/platform/reports/search

Searches reports. Different filter format: filters.type is required, other filters use operators like {"name": {"contains": "…"}}.

Example

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/platform/reports/search?page_size=25' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "filters": {
    "type": "easm_executive_summary"
  }
}'

Python

import requests

url = "https://api.deepinfo.com/v1/platform/reports/search"

params = {
    "page_size": "25"
}

headers = {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {
    "filters": {
        "type": "easm_executive_summary"
    }
}

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

JavaScript

const url = "https://api.deepinfo.com/v1/platform/reports/search?page_size=25";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    filters: {
      type: "easm_executive_summary"
    }
  }),
});

const data = await response.json();
console.log(data);

package main

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

func main() {
	payload := strings.NewReader(`{
  "filters": {
    "type": "easm_executive_summary"
  }
}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/platform/reports/search?page_size=25", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        String body = """
            {
              "filters": {
                "type": "easm_executive_summary"
              }
            }""";

        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/platform/reports/search?page_size=25"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString(body))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var body = """
    {
      "filters": {
        "type": "easm_executive_summary"
      }
    }
    """;

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/platform/reports/search?page_size=25");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent(body, Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$body = <<<'JSON'
{
  "filters": {
    "type": "easm_executive_summary"
  }
}
JSON;

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/platform/reports/search?page_size=25',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => $body,
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/platform/reports/search?page_size=25')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = <<~'JSON'.chomp
  {
    "filters": {
      "type": "easm_executive_summary"
    }
  }
JSON

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

200 OK · application/json

Response Body

{
  "page": 1,
  "page_size": 25,
  "result_count": 21,
  "results": [
    {
      "id": "000000000000000eab510001",
      "name": "Executive summary",
      "description": "A PDF report of your attack surface.",
      "creation_date": "2025-06-01T08:00:00Z",
      "creation_method": "instant",
      "rule_id": null
    },
    {
      "id": "000000000000000eab510002",
      "name": "Vulnerability report",
      "description": null,
      "creation_date": "2025-05-25T08:00:00Z",
      "creation_method": "instant",
      "rule_id": null
    }
  ]
}

Content-Type: application/json
deepinfo-request-id: 00000000-0000-4000-8000-0000356d0001

Request

curl

curl -X POST 'https://api.deepinfo.com/v1/platform/reports/search' \
  -H 'apikey: YOUR_API_KEY' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{}'

Python

import requests

url = "https://api.deepinfo.com/v1/platform/reports/search"

headers = {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
}

payload = {}

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

JavaScript

const url = "https://api.deepinfo.com/v1/platform/reports/search";

const response = await fetch(url, {
  method: "POST",
  headers: {
    "apikey": "YOUR_API_KEY",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({}),
});

const data = await response.json();
console.log(data);

package main

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

func main() {
	payload := strings.NewReader(`{}`)

	req, err := http.NewRequest("POST", "https://api.deepinfo.com/v1/platform/reports/search", payload)
	if err != nil {
		panic(err)
	}
	req.Header.Set("apikey", "YOUR_API_KEY")
	req.Header.Set("Accept", "application/json")
	req.Header.Set("Content-Type", "application/json")

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()

	body, err := io.ReadAll(res.Body)
	if err != nil {
		panic(err)
	}
	fmt.Println(string(body))
}

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

public class Main {
    public static void main(String[] args) throws Exception {
        HttpRequest request = HttpRequest.newBuilder()
            .uri(URI.create("https://api.deepinfo.com/v1/platform/reports/search"))
            .header("apikey", "YOUR_API_KEY")
            .header("Accept", "application/json")
            .header("Content-Type", "application/json")
            .POST(HttpRequest.BodyPublishers.ofString("{}"))
            .build();

        HttpResponse<String> response = HttpClient.newHttpClient()
            .send(request, HttpResponse.BodyHandlers.ofString());

        System.out.println(response.body());
    }
}

using System;
using System.Net.Http;
using System.Text;

using var client = new HttpClient();

var request = new HttpRequestMessage(HttpMethod.Post, "https://api.deepinfo.com/v1/platform/reports/search");
request.Headers.Add("apikey", "YOUR_API_KEY");
request.Headers.Add("Accept", "application/json");
request.Content = new StringContent("{}", Encoding.UTF8, "application/json");

using var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_URL => 'https://api.deepinfo.com/v1/platform/reports/search',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'apikey: YOUR_API_KEY',
        'Accept: application/json',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{}',
]);

$response = curl_exec($curl);

if ($response === false) {
    throw new RuntimeException(curl_error($curl));
}

echo $response . PHP_EOL;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.deepinfo.com/v1/platform/reports/search')

request = Net::HTTP::Post.new(uri)
request['apikey'] = 'YOUR_API_KEY'
request['Accept'] = 'application/json'
request['Content-Type'] = 'application/json'
request.body = '{}'

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(request)
end

puts response.body

Response

400 Bad Request · application/json

Response Body

{
  "code": 10400,
  "parameters": [
    {
      "param": "filters",
      "details": [
        "This field is required."
      ]
    }
  ],
  "solution": "https://docs.deepinfo.com/reference/"
}

Content-Type: application/json
deepinfo-request-id: 00000000-0000-4000-8000-0000356d0001

Authentication

Send your API key in the apikey request header.

Query Parameters

Parameter	Required	Description
`page_size`	Optional	Min `25`, max `100`. Default `100`. Example`25`
`page`	Optional	Min `1`, max `800`. Default `1`. Example`1`

Request Body

Parameter	Type	Required	Description
`filters`	object	Required	See Filtering below
`sort`	object	Optional	One `{field, order}` object

application/json

{
  "filters": {
    "type": "easm_executive_summary"
  }
}

This search takes filters as an object with one key per field, not as a must list. Each field takes the operators of its filter type as keys, and fields combine with AND. sort is one {field, order} object, not a list. Example body:

JSON

{
  "filters": {
    "name": {
      "equals": "<value>"
    }
  },
  "sort": {
    "field": "name",
    "order": "desc"
  }
}

Operators by field:

Field	Operators
`name`	`equals`, `not_equals`, `contains`
`type`	a plain value: `easm_executive_summary`, `easm_weekly_progress`, `easm_asset_detail`, `easm_vulnerability_detail`, `easm_vulnerability_overview`, `easm_issue_overview`, `easm_issue_detail`, `cti_email_breach_summary`
`type_context`	`equals`, `not_equals`
`description`	`contains`
`creation_date`	`gt`, `gte`, `lt`, `lte`
`creation_method`	a plain value: `instant`, `scheduled`
`rule_id`	a plain string value

Searchable Fields

Field	Description
`name`	The report's name, such as `executive-summary-2025-06-01-08:00`.
`type`	Required. The report type to search, such as `easm_executive_summary`, `easm_asset_detail` or `cti_email_breach_summary`. One search covers one type.
`type_context`	The options the report was made with (for example, which asset an asset detail report covers), an object compared as a whole.
`description`	The report's description.
`creation_date`	When the report was created (ISO 8601 date-time).
`creation_method`	How the report was made: `instant` (on demand) or `scheduled` (by a scheduled report rule).
`rule_id`	The ID of the scheduled report rule that made the report; `null` in the response for instant reports.

Sortable Fields

Field	Description
`name`	The report's name, such as `executive-summary-2025-06-01-08:00`.
`description`	The report's description.
`creation_date`	When the report was created (ISO 8601 date-time).
`creation_method`	How the report was made: `instant` (on demand) or `scheduled` (by a scheduled report rule).

Response Fields

Field	Type	Description
`page`	integer
`page_size`	integer
`result_count`	integer
`results`	array of object
`results[].id`	string
`results[].name`	string
`results[].description`	string
`results[].creation_date`	string	date-time
`results[].creation_method`	string	One of `instant`, `scheduled`
`results[].rule_id`	string

Paginated. See Getting Started → Pagination.

Response Schema

Inferred from examples Built from the saved 2xx example response: the fields it contains, with the types seen there. It is not a contract.

Field	Type	Example
`page`	number	`1`
`page_size`	number	`25`
`result_count`	number	`21`
`results`	array<object>
`results[].id`	string	`"000000000000000eab510001"`
`results[].name`	string	`"Executive summary"`
`results[].description`	string \| null	`"A PDF report of your attack surface."`
`results[].creation_date`	string	`"2025-06-01T08:00:00Z"`
`results[].creation_method`	string	`"instant"`
`results[].rule_id`	null

Examples

Selecting one loads it into the request and response panels.

Reference updated September 27, 2026