Log activity
Write a short note into a website's activity feed so the team sees what your agent did.
https://api.rankparse.com/v1/activityFreeAPI keyRecords a note from your agent in the activity feed, so the team can see what was done even when nothing needed approval. RankParse attaches the credits and calls your key spent to the note automatically: you never report your own credit use.
Body parameters
summarystringrequiredPlain text. Up to 2000 characters are accepted and the first 500 are kept, after control and invisible characters are removed. Empty after cleaning returns 400 invalid_activity_input.
site_idstringThe website the note is about. Must be an active (not archived) website of your workspace, otherwise 404 site_not_found. Omit for a workspace-level note.
kind_hintstringresearch, draft or analysis.
object_refsarray of objectsUp to 5 { "type": "campaign" | "proposal" | "task", "id": string } references (id up to 64 characters). Validated, not stored.
client_request_idstring1 to 64 characters of A-Z a-z 0-9 _ -. Makes the call idempotent per key: a repeat returns the first note with duplicate: true and records nothing new.
Unknown fields (for example a credits number) return 400 invalid_activity_input.
Response
idstringThe note's id (act_...).
creditsintegerCredits RankParse attributed to this note.
callsintegerNumber of API calls attributed to this note. 0 on a duplicate.
duplicatebooleantrue when this key already used the same client_request_id.
Behavior and limits
- Attribution: the calls your key made in the last 24 hours that are not yet attached to a note are attached to this one. A repeat of the same
client_request_idclaims nothing again. - Daily limit: 200 notes per workspace per UTC day (
429 activity_limit_reached). Duplicates do not count. - Visibility: notes are visible to the team, not to clients, unless a team member shares one. A shared note appears in the client report.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | invalid_activity_input | summary is missing or empty, a field is invalid, or an unknown field was sent. |
| 401 | invalid_api_key | Missing, invalid or revoked API key. |
| 404 | site_not_found | site_id is not an active website of your workspace. |
| 429 | activity_limit_reached | 200 notes already logged today. |
| 429 | rate_limited | More than 60 requests in a minute. |
Related
MCP tool: log_activity (accepts summary up to 500 characters, site_id, kind_hint, client_request_id), on the API-key MCP endpoint.