Report in: plugin, WordPress and PHP versions, the feed and where forms are used

POST

/api/v1/workspaces/{workspace}/wordpress/report

curl --request POST \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/wordpress/report \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "categories": [ { "id": "example", "name": "example", "slug": "example" } ], "feedUrl": "example", "forms": [ { "form": "frm_8c2e1a", "kind": "block", "places": [ { "title": "Join the beta", "url": "example" } ] } ], "languagePlugin": "wpml", "name": "example", "phpVersion": "8.3", "pluginVersion": "1.2.0", "siteUrl": "https://blog.acme.io", "woocommerce": { "checkouts": true, "consent": true, "version": "10.2.1" }, "wordpressVersion": "6.9.2" }'

• Your ReputeCast public URL

Permission: none

Keys: only a WordPress site’s key can call this operation.

The plugin reports when it connects, every 12 hours and with every post. ReputeCast never polls a site.

Authorizations

• bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Request Body^required

Media typeapplication/json

object

categories

Array<object>

<= 500 items

object

id

required

string

name

required

string

<= 200 characters

slug

required

string

<= 200 characters

feedUrl

string

<= 500 characters

forms

Array<object>

<= 100 items

object

form

required

The form’s id (frm_…)

string

<= 40 characters

kind

required

string

Allowed values: block shortcode widget

places

required

Array<object>

<= 100 items

object

title

required

string

<= 200 characters

url

string

<= 500 characters

languagePlugin

string

Allowed values: wpml polylang ""

name

string

<= 200 characters

phpVersion

string

<= 20 characters

pluginVersion

required

string

<= 20 characters

siteUrl

required

string

<= 300 characters

woocommerce

object

checkouts

required

Abandoned checkouts are reported

boolean

consent

required

The consent checkbox is at the checkout

boolean

version

required

string

<= 20 characters

wordpressVersion

string

<= 20 characters

Responses

200

OK

Media typeapplication/json

object

latestPlugin

required

string

site

required

The site’s address as ReputeCast lists it

string

workspace

required

string

workspaceName

required

string

Example ^generated

{
  "latestPlugin": "example",
  "site": "example",
  "workspace": "example",
  "workspaceName": "example"
}

default

Error

Media typeapplication/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}