Skip to content
Docs menu

Recipe: share a client visibility report

Goal: send a client a read-only, white-label link that shows what Google saw before and after your work, per link. No login needed on their side; you can stop sharing at any time.

The story · 3 steps
Get an API keyFree plan: 10 free links to try (once you verify your email), then 100 free checks a month, no card.

Prompt for your agent

1. Find the job

json
{
  "name": "list_jobs",
  "arguments": {
    "q": "Acme",
    "type": "index",
    "page_size": 5
  }
}
bash
curl "https://freshlycited.com/api/v1/jobs?q=Acme&type=index&page_size=5" -H "Authorization: Bearer ipk_YOUR_KEY"

2. Make sure the result is fresh

If the push hasn't been re-checked yet, run a visibility check on it (1 check credit per link) so the report shows the "after":

json
{
  "name": "check_index",
  "arguments": {
    "job_id": "job_…"
  }
}
json
{
  "name": "share_job_report",
  "arguments": {
    "job_id": "job_…"
  }
}
bash
curl -X POST https://freshlycited.com/api/v1/jobs/job_…/share -H "Authorization: Bearer ipk_YOUR_KEY"

The response includes url (for example https://freshlycited.com/r/…). Calling it again returns the same link. The report shows the before/after visibility, each link's status and when it was checked, without your account details or credit costs.

4. Stop sharing

json
{
  "name": "share_job_report",
  "arguments": {
    "job_id": "job_…",
    "revoke": true
  }
}

The old link stops working immediately. Prefer a spreadsheet? export_job_csv returns the same data as CSV.