Athena Documentation
Workflow
API Documentation
Mark name screen hits
curl --request POST \
--url http://localhost/api/api/namescreenhits/mark-as \
--cookie sessionid=Name Screen Hits
Mark name screen hits
Selectively assess specific hits by their IDs.
This endpoint updates only the specified NameScreenHits with the provided assessment decision. Hits can be from different engines.
Request Body:
- hit_ids (list[int]): List of hit IDs to update
- mark_as (str): Assessment decision (NO_ACTION, TRUE_HIT, FALSE_HIT)
- comment (str, optional): Comment for the assessment
Returns:
- success (bool): Whether the operation succeeded
- hits_updated (int): Number of hits updated
- updated_hit_ids (list): List of updated hit IDs
- breakdown (dict): Count of hits per engine
- message (str): Success or error message
- warning (str, optional): Warning if some IDs were not found
POST
/
api
/
namescreenhits
/
mark-as
Mark name screen hits
curl --request POST \
--url http://localhost/api/api/namescreenhits/mark-as \
--cookie sessionid=Documentation Index
Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Response
200
No response body
⌘I