Test

Ping

Use this endpoint to verify that your integration with the Moz JSON-RPC API works end to end, without spending any quota.

Pass a message to have it echoed back in the response. Pass error: true to make the request fail instead, so you can check your error handling.

See test.ping.async for the asynchronous equivalent.

JSON-RPC Method:

test.ping

Request

string

(Optional)

A message to return to the caller.

Default Value: Hello, world.

boolean

(Optional)

If true, the request will fail instead of returning a message. Use this to exercise the error handling in your integration.

Default Value: false

Response

Returns the message that was sent, or a default if none is provided.

string

The response message. This echoes the message that was sent, or the default if none was provided.

1{
2  "message": "hello, world."
3}

Example Code

Quota Usage

Requires access to the Moz API row quota, but uses zero rows per call.

api.limits.data.rows