The Report endpoint is provided to allow API users to send "report events" relating to interactions with each business listing back to Sensis. It takes
id parameters to provide information associated with each reporting event.
See also: Reporting Usage Events for more information.
env is the report to send the request to. Can be either
prod. Use HTTP POST method to submit report requests, HTTP GET method is deprecated for report endpoints.
Note: A list of valid
eventName values are listed in the Name column on the Event Types table at Reporting Usage Events.
The Report endpoint takes the following parameters:
||string||API key (required)||See Authenticating for details.|
||string||IP address of user accessing your application (required)||See Reporting Usage Events for details.|
||string||User agent of user accessing your application||For example, from the user-agent HTTP header. See Reporting Usage Events for details.|
||string||Session id of user accessing your application||See Note below.|
||string||Specific content to which the event applies (required)||Only required for certain events. See Reporting Usage Events for details.|
Note: We request that you provide the
userSessionId so that we can track a user's interaction with your application. It does not have to be the actual session id per se. For example, you may provide a derived value such as a hash of session id. This would be acceptable so long as a user's interaction with your application can be identified.
HTTP content type:
The response message is a JSON object containing the following members.
||array||Validation error messages (if any).||Returns an array of strings, one message per array item.|
||array||Validation warning messages (if any).||Returns an array of strings, one message per array item.|
||string||Date and time according to the server.||For example:
||number||Time taken to process the request.||Reported in milliseconds.|
||number||Response code.||Indicates success, failure or partial success (see below).|
||string||Response message.||Contains an error message (if any).|
The Report endpoint will always return HTTP 200 on success. See HTTP Status Codes for possible error codes.
The following status codes can be returned in the
||Success||The report event was successful.|
||The report event contained validation errors||May occur where some of the id parameters sent are invalid. Successful report events will only be captured for the valid id(s).|
||Validation error||Invalid or missing input parameters given. See Validation Errors.|
See also: Reporting Usage Events for a list of all events which can be reported and sample java code to submit report events.
See also: Examples for how to call endpoints from code.
- Documentation Overview
- Intro into using SAPI
- Using Endpoints
- Common Fields
- Status Codes and Messages
- Validation Errors
- Spell Checker
- Search Query Tips
- Reporting Usage Events
- Filtering Unsafe Content
- Category Filtering
- Postcode Filtering
- Radius Filtering
- Address Search
- Suburb Filtering
- State Filtering
- Bounding Box Filtering
- Filtering by Content Type
- Filtering by Product Keyword
- Location Tier Filtering
- Filtering by Polygon
- Endpoint Reference