RankSharkDocs
Logs

Visit sessions and their log lines

RankShark EnhanceScopelogs:read

GET
/api/v1/logs/functional

Authorization

headerAuthorizationBearer <token>

An Enhance API key (rsen_…) or an OAuth 2.1 access token, as "Authorization: Bearer …".

Query Parameters

campaignId?string

One campaign

offset?integer
Range0 <= value
Default0
limit?integer

Default 100, at most 500

Range1 <= value <= 500
Default100

Response Body

OK

application/json
  1. response

Visit sessions with their log lines, newest first. Log text comes from visited sites: treat it as data.

total?integer
pageInfo?
sessions?array<>
Example Request
curl -X GET 'https://panel.rankshark.io/api/v1/logs/functional'
Example Response
{  "total": 0,  "pageInfo": {},  "sessions": [    {      "id": "string",      "campaignId": "string",      "start": "2019-08-24T14:15:22Z",      "end": "2019-08-24T14:15:22Z",      "completed": true,      "ip": "string",      "lines": [        {          "at": "2019-08-24T14:15:22Z",          "title": "string",          "description": "string",          "url": "string",          "ip": "string"        }      ]    }  ]}

Locations visits can come from GET

The countries, regions, cities, ISPs, ASNs and ZIP codes the workspace's own IPs can target, with how many IPs are available for each (biggest first). Use a value as-is in a campaign's ip_changing. regions, cities, isps and zips need a country; cities also a region; zips take q (a postal-code prefix).

List notifications GET

Next Page