GET
/
v1
/
analyses
/
list
List analyses
curl --request GET \
  --url https://searchlysis.com/api/v1/analyses/list \
  --header 'x-api-key: <api-key>'
[
  {
    "createdAt": "<string>",
    "updatedAt": "<string>",
    "analysisId": "<string>",
    "analysis": {
      "title": "<string>",
      "url": "<string>",
      "publishedDate": "<string>",
      "author": "<string>",
      "score": 123,
      "id": "<string>",
      "image": "<string>",
      "favicon": "<string>",
      "extras": {
        "imageLinks": [
          "<string>"
        ]
      },
      "text": "<string>"
    },
    "textContent": "<string>",
    "jsonContent": {},
    "metadata": {}
  }
]

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
pageNum
integer
default:1
Required range: x >= 1
​
pageSize
integer
default:10
Required range: x >= 1
​
selectFields
string

Comma separated list of fields to select

Examples:

"analysisId,createdAt,updatedAt,analysis,textContent,jsonContent"

​
metadata
string

User defined key-value pair where the key is a string, and the value can be a string, number, boolean, or null.

Examples:

"{\"key\":\"value\"}"

​
jsonContent
string

User defined json schema.

Examples:

"{\"key\":\"value\"}"

Response

200 - application/json

Successful operation

​
createdAt
string
required
​
updatedAt
string
required
​
analysisId
string
required
​
analysis
object
required
​
textContent
string

The full text of the generated content.

​
jsonContent
object

The json object of the generated content.

​
metadata
object

User defined key-value pair where the key is a string, and the value can be a string, number, boolean, or null