# Rightlander API > Rightlander monitors affiliate partners for brands: the websites and social profiles that promote them. It checks them for compliance problems, risk and growth opportunities. This API returns the same data a customer sees in Rightlander, for their own account only, as JSON. These instructions are generated from the live API catalogue (version v1, 16 Nov 2026). Human-readable documentation and a request playground: https://aw1.rightlander.com/intelv2/partnerIntelApiPortal.php. OpenAPI 3.1 spec: https://aw1.rightlander.com/apis/rightlander/v1/openapi.php. For the fields each endpoint returns, read the full version: https://aw1.rightlander.com/apis/rightlander/v1/llms.php?full=1 ## Instructions for the AI assistant You are helping a Rightlander customer use their data. Follow these rules: - Base address: `https://aw1.rightlander.com`. Each endpoint below gives its full address. - Authentication: send the customer's API key as `Authorization: Bearer `. Only if a tool cannot set headers, add `apikey=` to the query string instead. - Keep the key secret. Never print it, repeat it, put it in code you show, store it in a file or send it anywhere except this API. If the customer has not given you one, help them create one (see Getting access). - The key decides whose data comes back. Never send a masterusercode or try to read another account. - Some calls spend credits: what happened across your partner programme, newest first (1 credit per day, per account); send affiliate domains to be scanned, for your network or for one client (1 credit). Before making one, tell the customer what it will cost and wait for them to agree. - Discover before you ask for detail. Use the listing endpoints (assets, reports, compliance markets) to find the ids, markets and months that exist rather than guessing them. - Check `ok` in each response. On failure branch on `error_code` rather than the message text. Explain the problem to the customer in plain words. - Lists are paged. Pass `cursor` from `next_cursor` until it is null. Ask before pulling a very large data set, because each page is one request from the daily allowance. - Watch `request.rate_limit.remaining`. On a 429 stop and tell the customer when the allowance resets (the Retry-After header gives the seconds). - Do not call endpoints listed under "Coming later". They are not available yet. - The API is read only apart from the credit-spending calls above and the network endpoints. Actions on compliance items are still taken in Rightlander itself. - When you summarise or chart the data, say what it covers (the market, the period, the source) and how fresh it is. Do not present an empty result as "no problems": say what was searched. - Links in the data (screenshots, pages in Rightlander) need the customer to be signed in to Rightlander. Pass them on rather than trying to open them. ## Getting access For the person setting this up. Only the main account login can create API keys: a user login cannot. 1. Sign in to Rightlander and open API Access: https://aw1.rightlander.com/intelv2/partnerIntelApiKeys.php 2. Create a key for your AI tool. Give it a label naming the tool and tick only the Read permission unless you need more. Set a time limit (7 or 30 days) so it stops working on its own. 3. Copy the key straight away. It is shown once and cannot be retrieved later. 4. Where you can, put the key in the tool's connection or secrets settings rather than typing it into a chat. 5. Revoke the key on the same page when you have finished with it, or if it may have been seen by anyone else. If your account does not have the API switched on yet, a new key works as a trial of 25 read requests in total. The compliance API (your Compliance Workbench data) is switched on separately, with its own daily allowance. Your account manager can switch either on. ## Ways to connect ### A chat assistant Give the assistant these instructions (or the link to them) and a key. It needs to be able to make web requests or run code to call the API. If it cannot, it can still write the requests or a script for you to run yourself. ### Custom assistants, actions and OpenAPI tools Import the OpenAPI spec from https://aw1.rightlander.com/apis/rightlander/v1/openapi.php. Choose API key authentication of the Bearer type and enter your key. The spec lists the live endpoints with their parameters and response shapes. ### MCP servers Use an MCP server that turns an OpenAPI spec into tools: point it at the spec URL above and set the header `Authorization: Bearer `, ideally from an environment variable such as `RIGHTLANDER_API_KEY`. A general HTTP request MCP server works too if you configure the same header. Then give your assistant these instructions so it knows when to use which tool. ### Spreadsheets, BI and automation tools Google Sheets, Excel (Power Query), Power BI, Zapier and Make can all read the JSON this API returns. Tools that cannot set a header can put the key on the query string as `apikey=`: treat that URL as secret. Use `limit` and `cursor` to page through long lists, and schedule refreshes no more often than the data changes (see each endpoint's freshness). ## Example tasks - **Show this scan cycle's unresolved compliance issues in one market, grouped by partner.** Call the scan cycle endpoint with the market (iso) and status=unresolved, page through all of it, then group by partner domain. (`compliance_cycle`) - **Chart how compliance issues were dealt with month by month.** List the months with the compliance markets endpoint, read each month with the month endpoint, then count items by status for each month. (`compliance_month`) - **List our partner sites and social profiles and when each was last scanned.** Call the assets endpoint, paging with cursor until next_cursor is null. (`assets_list`) - **Explain the risks on one partner site.** Call the domain endpoint with sets=risk and summarise the risk score and the evidence behind it. (`domain_get`) - **Run one of our standard reports.** List the reports available to the account first, then run the one the customer picks by its id. (`report_get`) - **Tell me what happened across our partners this week.** Call the activity feed with days=7. It costs credits for each day and each account requested, so confirm first. (`activity_feed`) ## How the API works ### Overview The Rightlander API gives you programmatic access to the partner intelligence you already see in the workbench: the domains and social profiles connected to your programme, everything we hold on any one of them, and the alerts we raise about them. It is a REST API. Resources live under /apis/rightlander/v1, responses are JSON, and every response carries an "ok" boolean so a failure is never mistaken for an empty result. There are four things you can do. List your assets. Retrieve one asset in as much or as little detail as you want. Ask us to refresh a social profile. Read your alerts. And one way to keep up without asking about each asset in turn: the activity feed lists what changed across your whole programme, newest first. Affiliate networks can also send us domains to scan, for themselves and for each of their clients, and read one client's feed at a time. See Networks and clients. Compliance teams can read what they see in the Compliance Workbench, with the actions taken on each item, by market and month or for the current scan cycle. See Compliance Workbench. Domains are scanned on a schedule set by your subscription, so there is no endpoint to force a domain rescan. Social profiles can be refreshed on demand because the cost of doing so is yours to decide. ### Authentication Every request needs an API key. Create one on the API Access page; it is shown once and stored only as a one-way hash, so keep a copy somewhere safe. Send it as a bearer token: Authorization: Bearer rl_xxxxxxxxxxxx_... Your account is resolved from the key. You do not need to send an account code, and if you do send one it must match the key or the request is rejected with 403 account_mismatch. If your tool cannot set request headers - a spreadsheet import, for example - you can pass the key as ?apikey= instead. It works, but the key then appears in browser history and server logs, so prefer the header wherever you can. Each key carries permissions. A key with read only cannot trigger a refresh, which makes it safe to hand to a reporting tool or a partner. A key can also be given a time limit when you create it: 24 hours, 7 days, 30 days or 90 days. Once it passes, requests with the key are refused with 401 key_expired. Use one for a test or a prototype so it stops working on its own. The limit cannot be extended, so create a new key when you need longer. ### Rate limits Your account has a daily request allowance. Every response tells you where you stand: request.rate_limit in the body, and X-RateLimit-Limit / X-RateLimit-Remaining in the headers. The allowance resets at 00:00 UTC. Exceed it and you get 429 rate_limited with a Retry-After header. Failed authentication does not count against the allowance, so a misconfigured client cannot exhaust your day before you notice. Per-second burst limiting is coming. The daily allowance is a quota, not a rate limit: today it stops you using more than you bought, but it does not stop you spending it all in one minute. When burst limiting arrives it will use the same 429 response and its own headers, so a client written against the current behaviour will keep working. In the meantime, if you are backfilling, please pace your requests. A few per second is fine. The compliance endpoints have an allowance of their own, set for your account and 250 calls a day unless agreed otherwise. It is shared by the three of them and a compliance call does not use any of the allowance above. On a compliance call request.rate_limit and request.compliance_limit both show where you stand against it. Going past it returns 429 compliance_limit_reached. ### Data sets Asset detail endpoints return a lot. Rather than asking you to name individual fields, they group the response into three sets, and you ask for the ones you want with ?sets=. intel - what the asset is. Traffic, partner and ownership, connected domains and social profiles, brands found, commercial viability, the markets we have scanned, and brand exposure: where your brand appears across the asset. risk - what is wrong with it. The risk score and the evidence behind it, compliance review findings, and PPC brand bidding. growth - what to do about it. Target pages, offers, and AI influence: how the asset shows up in LLM answers. Ask for one (?sets=risk), several (?sets=intel,risk) or leave it off for everything. ?sets=core returns only the identity and status header, which is the cheapest call you can make against an asset. ### Assessments A social profile assessment is not a property of the profile. When we assess an account we do it against YOUR brands, your tracked competitors and the sectors you have configured, and the brand relevance in the result is judged against exactly those. The same TikTok account assessed for two customers produces two different answers, and we store them separately. That means a scan date on its own does not tell you what you need to know, so every social reference in this API carries an assessed_for block saying which of three things it is. basis your_account - we assessed this profile against your brands and sectors. Everything on the row is yours. basis generic - an assessment exists, but it was not made for you. Audience, posting activity, risk, quality and our read of what the account is are common to any account, so they are returned. The brand relevance is not: those tags were judged against somebody else, so we remove them and recompute relevance and sector fit from your own configuration instead. You get an answer, and it is yours. basis not_assessed - nobody has assessed this profile. There is a fourth value, unknown, which means we could not match the handle to a profile we hold. It is deliberately not the same as not_assessed, which would claim we had looked. last_assessed_for_you is null unless basis is your_account. last_assessed dates whatever data is actually being returned. Where a successful assessment was followed by a failed one, both dates report the successful one - a failure does not replace an assessment we already hold. rescan_recommended is true for anything that is not your_account. Requesting a refresh on a generic profile is what turns it into yours, and it costs the same as any other refresh. We never tell you which other account holds a generic assessment. basis is a fixed set of values and the dates carry no owner, because that would tell one customer something about another customer. ### Credits Reading data does not cost credits. It is covered by your daily request allowance. The one exception is the activity feed, at 1 credit per day of history per account. It is charged only when the feed returns something - an empty window is free - and never on a trial. Credits pay for the two operations that make us go and do new work: a social profile refresh at 10 credits, and an LLM influence refresh at 1,500 credits. The gap is real - an LLM refresh runs twelve searches, a social refresh is one fetch. Credits are taken when the job is accepted, not when it finishes, and returned in full if we cannot start it. Your balance and a full statement are on the API Access page. A request that would leave you short is refused with 402 insufficient_credits before any work starts, and tells you the cost and your balance. ### Networks and clients An affiliate network uses the API on behalf of the advertisers it works with. Three things make that work. Guided setup. Once we have set your account up as a network, sign in at https://aw1.rightlander.com/intelv2/partnerIntelNetworkAdmin.php with your usual Rightlander username and password (the main user of your account). The guided setup opens straight away and takes you through everything on this page: your branding, getting your partner domains to us, the daily feed, the "Personalise my feed" button and the daily job for each client. Each step says up front who does it and what to have ready. Progress is saved, so you can stop and come back from the same address. Your API key is generated automatically during the setup, so there is no key to create first. It is shown at the top of every step and every example already carries it (and your signing secret), whenever you sign in to the setup. The Test step shows which of your server's calls have succeeded. If you ever need to replace the key, make a new one from the setup: it goes straight into the examples and the old one stops working. Your domains. Send your affiliate domains with POST /v1/partner-domains and we scan them under your account. Your activity feed then covers them, and every item carries the affiliate_id you sent with the domain. Your clients. You know each advertiser by your own ID; send it as client_ref. Send that client's partner domains with the same call and client_ref, and once the client signs up for a personalised feed they are scanned under the client's own account, against its own brands. GET /v1/clients lists who has signed up. One feed per client. GET /v1/activity?client_ref=... returns that client's feed: items from its own account marked scope client, and items from your scans marked scope network, both limited to the domains you sent for it. A client who has not signed up, or has cancelled, gets the network items only. Keep client_ref out of anything your client can edit. It is how one client's feed is kept from another's, so it must come from your own record of who is logged in, never from a URL. The button. Put a "Personalise my feed" button beside the feed on your site. We give you its link ready-made: your daily job sends your client list with GET /v1/clients?client_refs=A,B,C (up to 100 per call, including clients you have not sent us before) and saves each one's personalise_url for the day. It is signed for that client and works for 7 days, so your page only has to show the saved link, with no call of its own. To fill in the request form for the client, add any of email, name, company, brand and domain (the brand's website) to the end of the link, URL-encoded, with no signing: for example personalise_url + '&email=jo%40brand.com&brand=Brand&domain=brand.com'. The email is then shown read-only; the others can be changed by the client. An email at a free email service such as hotmail.com is refused unless you sign it (gmail.com is accepted). An email that is not at the brand's website or one of your own domains is accepted, but the client is asked why and its feed waits until Rightlander has checked it. If you want the name and company locked as well, you can instead build and sign the link on your own server with your signing secret (GET /v1/network gives you both). Either way the link opens our pages in your branding. Mark the link with data-rl-personalise and add our script once to the page (), and the link opens in a modal over your page, 80% of the screen, instead of a new tab: the client fills in its request, tells us about its products and ends on a review of what it asked for, with no login. Your page reloads when a client who finished closes the modal; RightlanderPersonalise.open(url), .close() and .onClose let your own code drive it instead. If your clients are billed through Rightlander or trackback.io the personalised feed starts straight away; if you bill your own clients we tell you, and the feed starts when you approve it with POST /v1/clients. Users. A network can personalise per user instead of per client (agreed with Rightlander). Send each user's id as uid with client_ref: POST /v1/partner-domains with uid sends that user's partner domains (its suggested scan credits come from that list), GET /v1/activity?client_ref=...&uid=... returns that user's feed, and the personalise_url we give you is signed for that user. A user who personalises joins its company's account with us as a user of it; the first from a company is asked for the company's brand, and later colleagues just join. A request with client_ref and no uid is for the client as a whole. Webhooks and GET /v1/clients carry uid for user subscriptions. Webhooks. Set a webhook URL with POST /v1/network and we post client.requested, client.approved, client.declined, client.activated, client.setup_completed, client.allocation_changed, client.deactivated and client.cancelled to it, signed in X-RL-Signature with your signing secret. The guided setup can send a test event, test.ping, to check your URL. A delivery that does not get a 2xx answer is tried again after 5 minutes, 15 minutes, 1 hour, 4 hours and 12 hours, with the same body; X-RL-Delivery carries the event id and X-RL-Attempt the try, so you can ignore a repeat you have already processed. Usage. One scan credit covers one partner domain in one market for a month: we examine the domain for pages relevant to the client's products and brands, then scan up to 50 of those pages for links, competitors, risk and influence (more by arrangement), plus up to 40 posts on up to 4 social profiles found on it, where it has them; for a client that is social only, a credit covers the social profile you send us. A client's full cycle is its domains times its markets. A client can have more partner domains than credits: we scan as many as its credits cover each month and work through the rest over the following months, then start round again, so its credits set the pace. We suggest an amount from the domains you send, and each client has its own monthly allocation. Scan credits and product profiles. A client buys a monthly allowance of scan credits in units of 1,000 (1,000, 2,000, 3,000 and so on, up to 500,000). One scan credit covers one partner domain in one market, with its pages and social profiles (see Usage). The client chooses its credits when it clicks "Personalise my feed" (we suggest an amount from the partner domains you sent), and each client gets 3 product profiles per market unless agreed otherwise, with extra product profiles available as a monthly add-on. A profile for a product in another country means scanning partner domains in that market too, so it can need more credits. If you bill your own clients, Rightlander bills you each client's credits at your price per scan credit, plus each extra product profile at your profile price, both agreed with you and shown on your admin screen and in GET /v1/network (pricing); you set and keep your own price to your clients. Change an approved or active client's credits or extra profiles with POST /v1/clients action=change, or on your admin screen. More applies straight away and is charged from the current month - the difference, invoiced separately; fewer takes effect on the 1st of next month. Scan credits are separate from the API credits below, which pay for your API calls. Item links. Every item in your feed, and in each client feed, carries a link: a read-only page showing that one item, which your client can open without a Rightlander login. It shows your name, logo and colour, or a plain page if you set item_branding to neutral, and nothing on it leads into Rightlander. A link works for 30 days, and the same item keeps the same link each time the feed returns it. Ready-made HTML. Choose how your feed looks in the Network feed step of your guided setup, which previews one item of each kind, or with feed_style on POST /v1/network. Add render=html to GET /v1/activity and each item comes back as ready-made HTML in that style (events[].html), with the whole page in a wrapper (render.html). Download the stylesheet once from that step and add it to your feed page: it is not sent with the daily feed. Category colours match ours. The data is still all there if you would rather build your own. What the network feed carries. Critical risks on partner sites and social profiles; Brand bidding indicators (the partner domain has been seen bidding on brand searches - never which brands, for privacy, so these rows carry brands_hidden and no ad text or links; brand bidding on a client's own brands is a paid add-on the client buys outside its subscription, and then appears in its personalised feed); AI influence (partner domains AI assistants trust in general); and Relevant content. Offer changes and link anomalies are in personalised feeds only: they are about one client's own offers and affiliate IDs, and a site can rightly work with two clients on one network. Relevant content. Indications of topic or brand relevance that help clients spot publishers whose content fits their products or verticals: brand mentions, product relevance and growth opportunities found by generic product profiles we set up for your verticals. They have scope example, scope_label Relevant content and an example_note to show beside them, up to 5 per category a day. Once a client personalises, its own items take their place and its AI influence is for its own verticals - except growth opportunities: those stay, from across your whole programme, with scope_label Partner discovery, so the client can find publishers it does not work with yet. Client usernames. A client is never shown a Rightlander username unless you allow it (show_username on POST /v1/network, or your admin screen). By default the client only chooses a password at setup, so you need not name the service. Credits. The activity feed costs 1 credit per day of feed, for your own feed and for each client feed you fetch, and sending partner domains costs 1 credit per send (one POST /v1/partner-domains, up to 1,000 domains). Everything else a network uses - the client list, its settings, approving clients and the personalise links - is free. A network package includes a monthly credit allowance, added on the 1st of each month; monthly credits not used by the end of the month expire. Credits bought separately do not. Sending domains needs the domains permission on your key, and approving or cancelling clients needs the clients permission. A read-only key carries neither. The key the guided setup makes has both. ### Compliance Workbench The compliance endpoints return what your team sees in the Compliance Workbench: the issues found on partner pages and the action taken on each. Our compliance data is held by market and by month. Read one month with GET /v1/compliance/{iso}/{yyyymm}, or the current scan cycle with GET /v1/compliance/{iso}/cycle. The scan cycle is this month and last month together, the same items the workbench shows. It moves on the 1st of each month, so read the closing month by month if you need its final state. An issue found in both months of the cycle is returned once, from the newer month. also_reported_in names the other one. issue_key stays the same for the same issue on the same page from one month to the next, so you can follow it while the item id changes. Each item has a status: unresolved, flagged, non_issue or ignored. An actioned item carries action, with its scope (the whole site or one page), whether an ignore is temporary, a plain description, the name of the person who took it and when. origin carried_forward means the action was made in an earlier month and still applies. A flag or an ignore carried forward is not shown, as in the workbench: read the month the action was made to see it. Each item also has a source. discovery is our scanning across the market as a whole and requested is the scanning set up for your account alone, including the Batch Workbench. Both are returned together unless you ask for one with source. Screenshot links open the workbench's own screenshot after you sign in to Rightlander, so they are safe to store and share inside your team. The compliance API is switched on for your account separately from the rest of the API, so you can have one without the other. Compliance calls do not cost credits. They have their own daily allowance, 250 calls a day unless agreed otherwise. They do not count against your other API requests. The endpoints are read only: actions are still taken in the workbench. ### Errors Errors return the HTTP status you would expect plus a JSON body with ok:false, a human-readable "error" and a stable "error_code" to branch on. Match on error_code, not on the message text. missing_key / invalid_key / key_revoked / key_expired - 401. The key is absent, malformed, wrong, turned off or past its time limit. api_not_enabled - 403. API access is not switched on for the account. account_mismatch - 403. You sent an account code that does not belong to the key. scope_denied - 403. The key does not carry the permission this endpoint needs. insufficient_credits / daily_credit_cap - 402. Not enough credits, or the daily credit ceiling would be crossed. rate_limited - 429. Daily request allowance used. Retry-After tells you when it resets. invalid_parameter / invalid_category - 400. A parameter was malformed or out of range. The message names the problem and, for a category, lists the valid ones. Not counted and not charged. not_found - 404. We hold nothing for that asset, in that market, for your account. unknown_client - 404. You have not sent us that client_ref. Send its domains with POST /v1/partner-domains first. invalid_state / not_applicable - 409. The client is not in a state that allows this (only a requested client can be approved), or the action does not apply to your network (approval is for networks that bill their own clients). too_many_domains / invalid_json - 400. More domains than one request takes, or a body that is not valid JSON. Nothing is recorded. method_not_allowed - 405. The endpoint does not answer that HTTP method. not_subscribed - 403. The compliance API is not switched on for your account. month_not_found - 404. We hold no report table for that market and month. GET /v1/compliance/markets lists the months that exist. compliance_limit_reached - 429. Your compliance calls for the day have been used. Retry-After tells you when they reset. source_unavailable - 503. Compliance data could not be read. Nothing was counted. Retry shortly. server_error - 500. Ours. Retry with backoff; if it persists, tell us. feed_unavailable / billing_unavailable / intake_unavailable - 503. We could not read the data, bill the request or accept domains, so it was not run. Nothing is charged or recorded. Retry shortly. ## Endpoints Each endpoint gives its address, what it costs, the permission a key needs and its parameters. Values under "Always send" choose the request and must be included. ### Assets #### List every domain and social profile connected to your account (`assets_list`) `GET https://aw1.rightlander.com/apis/rightlander/assets.php` Cost: free within your daily allowance. Permission: read. One entry per asset. Domains and social profiles come back in the same list, each carrying its type, the identifier the detail endpoints take, where it came from, when we last looked at it and whether you can ask us to look again. When to use it: Start here. Walk it with the cursor to synchronise your own systems, or filter it to find the identifier you need. Domains are returned first, alphabetically, then social profiles by platform and handle. Parameters: - `type` (string, query, default all): Restrict to one kind of asset. Values: all, domain, social. - `detail` (string, query, default simple): simple returns identity and status. full adds partner, vertical, traffic band, and the social accounts found on each domain, each with its own assessed_for block. Values: simple, full. - `iso` (string, query): Two-letter market code. Applies to domains only - social profiles are not market scoped. - `platform` (string, query): Restrict the social side to one platform. Values: instagram, tiktok, youtube, twitter, pinterest. - `search` (string, query): Substring match on the domain or the handle. - `limit` (integer, query, default 100): Rows per page, up to 500. - `cursor` (string, query): Pass back the next_cursor from the previous response. Null next_cursor means you have seen everything. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/assets.php"` Freshness: Reflects the most recent completed scan or assessment for each asset. last_scanned dates every row. Coverage: Domains are those your account has compliance activity for. The social SEGMENT is your own assets: profiles assessed for your account plus any currently queued, minus any you have excluded. The social accounts listed on a DOMAIN row are a different set - they are whatever that site links to, so many of them are assessed for somebody else or not at all, which is what their assessed_for block tells you. Health findings are not on this list - use Domains only or By Domain for those. Notes: Paging is by position, not offset, so rows added or removed between calls cannot make you skip or repeat one. next_cursor of "s:" with no key means the domains are finished and the social segment starts next. CHANGED 10 AUG: at detail=full, a domain row's social_profiles was a list of "platform:handle" strings and is now a list of objects. The id field carries the exact string it used to, so reading .id is the whole migration. #### Summary row per domain (`domain_list_legacy`) `GET https://aw1.rightlander.com/apis/rightlander/domain-list.php` Always send: `action=list`. Cost: free within your daily allowance. Permission: read. The per-domain summary the Domain Intelligence table is built from: scan status, vertical, sub-network detection, partner, traffic band, health priority counts, social profiles and top countries. When to use it: Use this when you want the domain view specifically. For domains and social profiles together, use /v1/assets. Parameters: - `iso` (string, query): Two-letter market code. Omit or send XX for all markets. - `search` (string, query): Substring match on the domain. - `include` (string, query): raw adds the heavier exposure, offers and growth blocks per domain. Values: raw. - `health` (string, query): Restrict to domains with health findings. Values: 1. - `auditfilter` (string, query): Audit field id to require a match for. Adds audit_evidence to each row. - `limit` (integer, query, default 5000): Maximum rows, capped at 5000. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/domain-list.php?action=list"` Freshness: Scan status and dates come from the latest run per domain and market. Coverage: One entry per domain your account has compliance activity for. ### Reports #### List the reports your account can run (`reports_list`) `GET https://aw1.rightlander.com/apis/rightlander/reports.php` Cost: free within your daily allowance. Permission: read. Every report on your Reports board, with the id to run it, the views it offers, the periods it can be narrowed to and the exact columns it will return. When to use it: Start here. Your report set is not the same as anybody else's - it is built from your vertical, your audit priorities and your subscription - so the ids have to be discovered rather than hardcoded. Parameters: - `iso` (string, query): Two-letter market code. Affects which risk reports exist, because priorities can be set per market. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/reports.php"` Freshness: The list itself is built per request from your current configuration, so a report appears the moment a gate opens and disappears when one closes. Coverage: Only reports that can actually be served are listed. A report the index cannot yet answer is left out rather than listed and then refused, and a report an administrator has archived is off the API for the same reason it is off the board. Notes: columns reflects YOUR configuration - the columns an administrator marked essential plus the optional ones you have switched on in the Configure sidebar. Rename a column there and the label here follows; the key never changes. #### Run one report and return its rows (`report_get`) `GET https://aw1.rightlander.com/apis/rightlander/reports.php` Cost: free within your daily allowance. Permission: read. The rows of one report, in the same columns and the same order as the spreadsheet that report downloads - because it is the same report definition, the same column set and the same sort, resolved once. When to use it: When you want a report as data rather than as a file: to feed a dashboard, to drive an outreach queue, or to diff against yesterday. Parameters: - `report` (string, query, required): A report id from /v1/reports. Omit it entirely and you get the list instead. - `grain` (string, query): Which view of the report. Defaults to the first one it offers; a report with only one view ignores this. Values: domain, social, page. - `iso` (string, query): Restrict to one market. Omit for every market. - `days` (integer, query): Period, for the reports that have one - see windows on the list. Anything else falls back to the widest the report offers. - `limit` (integer, query, default 100): Rows per page, up to 1000. - `cursor` (integer, query, default 0): Pass back next_cursor from the previous response. Null next_cursor means you have seen everything. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/reports.php?report=risk_adult_content_present"` Freshness: Facet-served reports read the overnight index and built_at dates it. The page reports read live tables and have no build date. Coverage: The same rows the download would produce for the same report, market and period. If the board shows a count on the card, this returns that many rows. Notes: ROWS ARE KEYED BY COLUMN KEY, NOT BY LABEL. A label is editable - an administrator renames it for every client and a user renames it for themselves - so keying off it would break the day somebody tidied a heading. The labels come back once, in columns. Paging is by offset here rather than by position: a facet report reads a nightly index that does not move during the day, which paging.stable reports. A page report reads live tables and says stable false. ### Activity #### What happened across your partner programme, newest first (`activity_feed`) `GET https://aw1.rightlander.com/apis/rightlander/v1/activity.php` Cost: 1 credit per day, per account. Permission: read. The Partner Activity Feed as data: critical risks, brand bidding, offer changes, link anomalies, growth pages, AI influence, partner post mentions and team activity, one row per item, ordered by when it happened. When to use it: Poll it once a day to drive your own alerting or a changelog, and de-duplicate on id. For what is outstanding rather than what changed, use Reports. Parameters: - `days` (integer, query, default 1): How far back to look, 1 to 90. 1 is the last 24 hours. Compared by day, like the daily alert email, so the window starts at midnight on the first day it covers. Sets the price. - `category` (string, query): Restrict to these kinds of item. Comma separated for more than one. Omit for all. An unknown value is a 400 that lists the valid ones. Values: risk_domain, risk_social, ppc, offers, anomalies, growth, llm, social_brand, social_comp, social_topic, team. - `iso` (string, query): Two-letter market code. Omit or send XX for every market. - `max` (integer, query, default 100): Most items to return, 1 to 500. The newest are kept; summary.capped says whether any were left out. - `accounts` (string, query): Comma separated account codes. Omit for the account your key belongs to. Each account read is charged separately, and a code your key is not authorised for is refused with 403. - `client_ref` (string, query): Networks: your ID for one client. Returns that client's feed - items from its own account (scope client) once it has signed up, and from your scans (scope network) - limited to the domains you sent for it. Cannot be combined with accounts; team items are left out. Charged as one account. - `uid` (string, query): Networks that personalise per user: one user of client_ref. Returns that user's feed - limited to the partner domains you sent for the user (the client's list until you send one), and the user's own items once it has personalised. client.personalise_url is signed for that user. Ignored, with a note, if your feeds are personalised per client. - `render` (string, query): html adds ready-made HTML in your feed style: each item's html, plus render.html for the whole page. The stylesheet is downloaded once from your guided setup, not sent here. Set the style in your guided setup or with feed_style on POST /v1/network. Omit for data only. Values: html. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/activity.php"` Freshness: Mixed, and every row says which. Critical risks, growth pages and link anomalies come from an index rebuilt overnight, so a finding from today's scan appears tomorrow and window.index_built_at dates it. AI influence follows its own scheduled build. Offer changes, partner posts and team activity are live. Coverage: Every partner site and social account on your account, less anything you marked as a trusted source and any item you dismissed. Your own sites, accounts and paid ads are left out - you are not your own partner. Brand bidding lists an advert once, on the day it was first seen; an advert already running before the window is not news and is not repeated. A source that could not be read is reported in sources rather than returned as a silent zero. Notes: ONE ITEM IS ONE ROW, however many times it was logged in the window: repeats says how often, last_seen_at how recently, and the row is dated by its FIRST sighting. The window is compared by day on purpose - a finding from the overnight index is dated at midnight on its scan day and only becomes readable the next morning, so a strict 24-hour clock would never return it. The price of that is an item from early on the first day appearing in two consecutive daily calls, which is what id is for. Parameters also answer to the Activity Feed page's own names - feeddays, feedmax, feedcat and feediso - so a URL copied from the page works. CHANGED 7 OCT: every item now carries scope and affiliate_id, and networks can pass client_ref - see the networks guide. ### Compliance #### Your compliance markets, months and reports (`compliance_markets`) `GET https://aw1.rightlander.com/apis/rightlander/v1/compliance.php` Always send: `view=markets`. Cost: free within your daily allowance. Permission: read. The markets you have compliance reports in, the month tables we hold for each and which source they come from. It also lists your reports with their ids and priorities. When to use it: Start here. It tells you which iso, month and report_id values the other two endpoints will answer for. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/compliance.php?view=markets"` Freshness: Live. Coverage: Reports your account owns, active or switched off. months are the tables that exist for a market, up to 24 months back; a month can exist and hold nothing for you. Notes: Counts against your daily allowance of compliance calls, 250 unless agreed otherwise. It does not use your other API requests. #### The items in the current scan cycle, with their actions (`compliance_cycle`) `GET https://aw1.rightlander.com/apis/rightlander/v1/compliance.php` Always send: `period=cycle`. Cost: free within your daily allowance. Permission: read. The items the Compliance Workbench shows for one market, from this month and last month together, with the action taken on each, who took it and when. When to use it: To keep your own systems in step with the workbench. Read it with since to pick up only what changed. Page it with limit and cursor. Parameters: - `iso` (string, query, required): Two-letter market, or XX for worldwide. - `source` (string, query): discovery is our scanning across the market as a whole and requested is the scanning set up for your account alone. Omit for both. Values: discovery, requested. - `status` (string, query, default all): Which items. resolved is any action. Omit for all of them. Values: all, unresolved, resolved, flagged, non_issue, ignored. - `report_id` (integer, query): One of your reports, from GET /v1/compliance/markets. - `report_priority` (integer, query): Reports of one priority: 1 high, 2 medium, 3 low. Values: 1, 2, 3. - `domain` (string, query): One partner domain. - `affid` (string, query): One affiliate ID. The prefixed forms the scanner records (btag=, affid= and so on) are matched too. - `brand` (string, query): One or more of your brand names, comma separated. - `state` (string, query): With iso=XX only: a two-letter state or country code the item was scanned in. - `since` (string, query): YYYY-MM-DD. Items reported, scanned or actioned on or after this date. - `detail` (string, query, default full): simple leaves out findings and returns finding_count and the short issue text in result. Values: full, simple. - `limit` (integer, query, default 100): Items per page, up to 500. - `cursor` (string, query): Pass back next_cursor from the previous response. Null next_cursor means you have seen everything. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/compliance.php?period=cycle&iso=GB"` Freshness: Live. An action taken in the workbench appears on the next call. Coverage: Items from your active compliance reports that the Compliance Workbench shows. Items from culled affiliates are left out, as in the workbench. Notes: summary comes back on the first page only. The cycle moves on the 1st of the month: a cursor issued before then is refused afterwards, so start again without one. #### The items reported in one month, with their latest action (`compliance_month`) `GET https://aw1.rightlander.com/apis/rightlander/v1/compliance.php` Cost: free within your daily allowance. Permission: read. The compliance items reported in one market in one month, with the latest action on each. Reports you have since switched off are included. When to use it: For history and reporting or to capture the final state of a month as it leaves the scan cycle. Parameters: - `iso` (string, query, required): Two-letter market, or XX for worldwide. - `month` (string, query, required): YYYYMM or YYYY-MM. GET /v1/compliance/markets lists the months that exist. - `source` (string, query): discovery is our scanning across the market as a whole and requested is the scanning set up for your account alone. Omit for both. Values: discovery, requested. - `status` (string, query, default all): Which items. resolved is any action. Omit for all of them. Values: all, unresolved, resolved, flagged, non_issue, ignored. - `report_id` (integer, query): One of your reports, from GET /v1/compliance/markets. - `report_priority` (integer, query): Reports of one priority: 1 high, 2 medium, 3 low. Values: 1, 2, 3. - `domain` (string, query): One partner domain. - `affid` (string, query): One affiliate ID. The prefixed forms the scanner records (btag=, affid= and so on) are matched too. - `brand` (string, query): One or more of your brand names, comma separated. - `state` (string, query): With iso=XX only: a two-letter state or country code the item was scanned in. - `since` (string, query): YYYY-MM-DD. Items reported, scanned or actioned on or after this date. - `detail` (string, query, default full): simple leaves out findings and returns finding_count and the short issue text in result. Values: full, simple. - `limit` (integer, query, default 100): Items per page, up to 500. - `cursor` (string, query): Pass back next_cursor from the previous response. Null next_cursor means you have seen everything. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/compliance.php?iso=GB&month=202610"` Freshness: Live. A month in the current scan cycle can still change. Coverage: Items from your compliance reports, active or switched off, that the Compliance Workbench would show. Notes: A flag or an ignore carried forward from an earlier month is not returned, as in the workbench: read the month the action was made to see it. ### Network #### Send affiliate domains to be scanned, for your network or for one client (`partner_domains_post`) `POST https://aw1.rightlander.com/apis/rightlander/v1/partner-domains.php` Cost: 1 credit. Permission: domains. Records the domains you send against your account, or with client_ref against one of your clients, and queues each new one for scanning: under your own account, or under the client's once it has signed up for a personalised feed. Every domain comes back with what was done with it. When to use it: Once a day, with each list in full and mode=replace, so ours always matches yours. Use mode=add for a few new domains in between, and mode=remove to take some off. Parameters: - `domains` (string, JSON body, required): Up to 1000 per request. In a JSON body, an array of strings or of objects { "domain", "affiliate_id", "iso" }. As a form field, domains separated by commas, spaces or new lines, each optionally as domain|affiliate_id or domain|affiliate_id|iso. A full URL is fine; it is reduced to its domain. - `iso` (string, JSON body): Two-letter market for any domain that does not carry its own. Needed unless every entry has one. - `client_ref` (string, JSON body): Your ID for the client these domains belong to. Omit to send your own network list. A client_ref you have not used before is created. - `uid` (string, JSON body): Networks that personalise per user: the user of client_ref these domains belong to. The list is that user's, and its size sets the user's suggested scan credits. Refused if your feeds are personalised per client. - `mode` (string, JSON body, default add): add keeps everything already on the list. replace removes anything not in this request. remove takes the domains named off the list. Values: add, replace, remove. - `client_name` (string, JSON body): Optional. The client's name, kept on its record. - `client_domain` (string, JSON body): Optional. The client's own brand site, which its partner list is filed under. Freshness: Queued domains follow the account's normal scan schedule; first results usually arrive within days. Domains already held keep the schedule they have. Coverage: Domains past the account's partner-site allowance are recorded and reported as over_allowance, and are queued by the next post once the allowance is raised. A client that has not signed up yet has its domains recorded as waiting and queued the moment it does. Notes: An empty replace is refused rather than read as "remove everything". A removed domain leaves the client's feed straight away. Not available on a trial key: scanning is a paid operation. One request against your daily allowance whatever the list size; no credits. #### The domains you have sent, and where each one's scan stands (`partner_domains_list`) `GET https://aw1.rightlander.com/apis/rightlander/v1/partner-domains.php` Cost: free within your daily allowance. Permission: read. Your network list, or with client_ref one client's, as we hold it: affiliate ID, market, whether it is active or removed, and its scan state. When to use it: To reconcile your records with ours, or to see which domains are still waiting for a client to sign up. Parameters: - `client_ref` (string, query): Your ID for the client. Omit for your own network list. - `uid` (string, query): One user of client_ref (networks that personalise per user). - `status` (string, query, default active): Which domains to list. Values: active, removed, all. - `limit` (integer, query, default 500): Rows per page, up to 5000. - `cursor` (string, query): Pass back next_cursor from the previous response. Null next_cursor means you have seen everything. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/partner-domains.php"` Freshness: Live. Coverage: Only what your account has sent. Domains the client added to its own account by other means are not on this list. #### Your clients, and which have a personalised feed (`clients_list`) `GET https://aw1.rightlander.com/apis/rightlander/v1/clients.php` Cost: free within your daily allowance. Permission: read. Every client_ref your account has used, with its status - pending, requested, approved, declined, active or cancelled - its usage estimate and allocation, and its partner domain counts. When to use it: In your daily job: send your client list with client_refs (up to 100 per call), save each client's status and personalise_url for the day, then call the activity feed with client_ref for each client with personalised true. Your feed page then needs no call. Parameters: - `status` (string, query, default active): Which clients to list. The default is the ones with a personalised feed; requested is the ones waiting for your decision. Values: active, requested, approved, declined, pending, cancelled, all. - `client_ref` (string, query): One client only, whatever its status, with its users. A client_ref we have not seen is recorded as pending. Use it to get the client's personalise_url for its button. - `client_refs` (string, query): Up to 100 clients in one call, comma separated, returned in the order sent whatever their status. New ones are recorded as pending. Each comes back with its status and, if not personalised, its personalise_url, so your daily job can save every client's button link for the day. Networks that personalise per user can send ref|uid entries. - `uid` (string, query): With client_ref: one user only, recorded as pending if new, with that user's own personalise_url (networks that personalise per user). - `limit` (integer, query, default 500): Rows per page, up to 1000. - `cursor` (string, query): Pass back next_cursor from the previous response. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/clients.php"` Freshness: Live. A client appears as active as soon as its sign-up is linked. Coverage: Only client_refs your own account has used. Two networks can use the same ID for different companies; each sees only its own. #### Approve, decline, cancel or change a client (`clients_decide`) `POST https://aw1.rightlander.com/apis/rightlander/v1/clients.php` Cost: free within your daily allowance. Permission: clients. Your decision on a client's request for a personalised feed, if you bill your own clients, a change to its monthly scan credits or extra product profiles, or the end of a client's feed. Approving returns the setup link the client finishes setup at. When to use it: When a client.requested webhook arrives, or a client appears in GET /v1/clients?status=requested, and you have agreed terms with that client. Cancel when a client stops paying you. Parameters: - `action` (string, JSON body, required): approve and decline need a requested client and a network that bills its own clients. change needs an approved or active client and a network that bills its own clients: more credits or profiles apply now, fewer from the 1st of next month. cancel works on a requested, approved or active client. Values: approve, decline, cancel, change. - `client_ref` (string, JSON body, required): Your ID for the client. - `uid` (string, JSON body): One user of the client: the action is on that user's subscription (networks that personalise per user). - `allocation` (integer, JSON body): Scan credits a month: a multiple of 1000, from 1000 to 500000. approve: omit to use what the client chose, or its estimate rounded up to the next 1,000. change: the new amount; omit to change only extra_product_profiles. - `extra_product_profiles` (integer, JSON body): Extra product profiles on top of those included, 0 to 50. approve: omit to use what the client chose. change: the new number; omit to keep it. - `note` (string, JSON body): Optional. Kept with the decision and sent in the webhook. Freshness: Immediate. The webhook for the decision is sent before the response. Coverage: Only client_refs your own account has used. Notes: Keep setup_url private to that client: whoever opens it sets up the account. It stops working once setup is finished, after 30 days, or if you cancel the client. ### Network settings #### Your network settings, signing secret and request link (`network_get`) `GET https://aw1.rightlander.com/apis/rightlander/v1/network.php` Cost: free within your daily allowance. Permission: clients. Your billing route (subscription or network), the package your clients get, your prices per scan credit and per extra product profile, your webhook URL and branding, and what you need to build the "Personalise my feed" button: the request link and your signing secret. When to use it: Once, when you build the button, and again after rotating your secret. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/v1/network.php"` Freshness: Live. Coverage: Your own network only. Notes: Billing and package are agreed with Rightlander; contact us to change them. The signing secret is returned only to keys with the clients permission. #### Change your webhook, branding or signing secret (`network_post`) `POST https://aw1.rightlander.com/apis/rightlander/v1/network.php` Cost: free within your daily allowance. Permission: clients. Set the URL we post client events to, the logo and colour your clients see on the pages they reach from your site, or replace your signing secret. Your display name is set by Rightlander. When to use it: When you first set up, and whenever your webhook endpoint or branding changes. Parameters: - `webhook_url` (string, JSON body): https only. Send an empty value to stop webhooks. - `logo_url` (string, JSON body): An https image URL, shown at the top of our pages for your clients. - `brand_colour` (string, JSON body): A hex colour like #1A4B8C for the header and buttons. - `feed_style` (object, JSON body): The look of GET /v1/activity?render=html. Any of: layout (cards, list), theme (light, dark), density (comfortable, compact), category_colours (ours, accent), accent (hex), radius (0 to 16), font (inherit, system), show_partner, show_markets, show_date, show_audience, show_evidence (true or false), button_text. Items always open in a new window. Only the settings you send change. - `feed_categories` (array, JSON body): What GET /v1/activity carries: any of risk_domain, risk_social, ppc, offers, anomalies, growth, llm, social_brand, social_comp, social_topic, as an array or a comma list. risk_domain and risk_social are always kept. Also set in the Network feed step of the guided setup. - `show_username` (string, JSON body, default 0): 1 lets your clients choose and see a Rightlander username at setup. 0 (the default): they only choose a password and are never shown one. Values: 0, 1. - `item_branding` (string, JSON body, default network): How the page behind each item's link looks: network shows your name, logo and colour; neutral shows no name or logo. Values: network, neutral. - `rotate_secret` (string, JSON body): 1 replaces your signing secret at once. Links signed with the old one stop working. Values: 1. Freshness: Immediate. Coverage: Your own network only. Notes: billing, package and display_name are set by Rightlander and are refused by name. ### Domains #### Everything we hold on one domain (`domain_get`) `GET https://aw1.rightlander.com/apis/rightlander/domain.php` Always send: `action=intel`. Cost: free within your daily allowance. Permission: read. The full picture behind the Domain Profile screen, as data. Traffic and audience, the partner and how to reach them, connected domains and social profiles, the risk score and the evidence for it, compliance findings, PPC brand bidding, growth target pages, offers and AI influence. When to use it: Use this for a single domain you already know about. Use ?sets= to keep the response to what you actually need - the full payload is large. Parameters: - `domain` (string, query, required): The domain, without scheme or path. - `iso` (string, query, default GB): Market to report against. Affects which scan and which compliance findings are used. - `sets` (string, query): Comma separated. Omit for everything. See Data sets. Values: core, intel, risk, growth, intel,risk. - `pagelimit` (string, query, default 10): Cap on URL lists inside the response. 0 or all lifts it. Counts alongside the lists are never capped. - `exclude` (string, query): Turns off blocks that are on by default. Values: posts, bios, posts,bios. - `include` (string, query): raw attaches the underlying scan payloads. Large. Values: raw. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/domain.php?action=intel&domain=example.com"` Freshness: Domain scans run to your subscription cycle, typically monthly. scan.scanned_at dates the evidence. Coverage: Markets you have scanning configured for. Ask for a market we have not scanned and the response says so rather than returning nothing. Notes: Every social profile row carries assessed_for, including rows whose state is unassessed or link_only - those are exactly the ones where somebody else may hold an assessment you could inherit by requesting a refresh. In the summary, assessed_for_you and generic do not add up to assessed: assessed counts the rows this endpoint could fill in, which has always been the ones assessed for you. ### Social profiles #### Everything we hold on one social profile (`social_get`) `GET https://aw1.rightlander.com/apis/rightlander/social.php` Cost: free within your daily allowance. Permission: read. Profile header and audience, posting cadence and engagement, the bio and the links inside it, the brands appearing in recent posts and how relevant each is to you, compliance findings with the posts that evidence them, and whether there is a gap worth approaching the account about. When to use it: Use this after /v1/assets has given you the platform and handle. You can pass the handle bare, with an @, or as a full profile URL. Parameters: - `platform` (string, query, required): Platform the profile is on. x is treated as twitter. Values: instagram, tiktok, youtube, pinterest, twitter. - `handle` (string, query, required): Account handle. The @ and a full profile URL are both accepted. - `sets` (string, query): Comma separated. Omit for everything. core is always returned. Values: core, intel, risk, growth, intel,risk. - `iso` (string, query): Market. Decides which product profile the brand relevance filter reads from. - `exclude` (string, query): Turns off blocks that are on by default. Each costs an extra lookup. Values: posts, bios, posts,bios. - `include` (string, query): raw attaches the underlying assessment payload. Large. Values: raw. - `usercode` (string, query): Only needed where product profiles are keyed per user. Defaults to the account. Example: `curl -H "Authorization: Bearer $RIGHTLANDER_API_KEY" "https://aw1.rightlander.com/apis/rightlander/social.php?platform=tiktok&handle=examplemedia"` Freshness: Social profiles are assessed on a monthly cycle, or whenever a refresh is requested. status.last_scanned dates the evidence, and assessed_for.last_assessed_for_you dates the last one made against your own brands. Coverage: Instagram, TikTok, YouTube and Pinterest are assessed in full. Twitter profiles carry a bio but are not scored. Other platforms are recorded as links only. If we hold no assessment made for you but somebody else has assessed the account, you get that one back marked generic rather than nothing - see the Assessments guide. Notes: Read assessed_for before acting on the brand and sector fields. A handle nobody has assessed returns 404; CHANGED 10 AUG, that used to also cover handles assessed for another account, which now return 200 marked generic. A handle with an assessment queued returns 200 with state "requested" - waiting and nothing-there are different answers. ### Coming later Documented in the portal but not available yet. Calling them returns 501 not_deployed. - Ask us to re-fetch and re-assess a social profile - Rebuild AI visibility for a product profile - Check the status of a refresh - List your recent jobs - What needs attention right now ## Returned with each response - `ok` (boolean): True on success, false on failure. Check this before anything else - an empty result and a failure are not the same thing. - `error` (string): Human-readable message. Present only on failure. - `error_code` (string): Stable code to branch on. Match on this, not on the message text. - `status` (integer): HTTP status, repeated in the body for clients that cannot see it. - `request.queried_at` (datetime): When we answered. - `request.took_ms` (integer): How long it took us. - `request.key_source` (string): header or query - where your key was read from. - `request.rate_limit.requests_per_day` (integer): Your daily allowance. - `request.rate_limit.used_today` (integer): Requests used today. - `request.rate_limit.remaining` (integer): What is left. - `request.rate_limit.resets_at` (datetime): When it resets. 00:00 UTC. - `request.credits_charged` (integer): Credits taken by this request. Present only when it cost something.