v1
Guide

Analyze content optimization score

Analyzes the optimization score of the provided content for a specific guide

post/api/v1/score

Request

  • Base URL: https://app.serpmantics.com (the document declares no server; this is the origin it was published from)
  • URL: https://app.serpmantics.com/api/v1/score
  • Auth: HTTP bearer

Request body

guideIdstring required

ID of the guide to analyze

contentstring required

Content to analyze

pageUrlstring

Optional. Read only for a visitor of a guide shared in read-only mode: the URL of one of the guide's SERP pages, whose stored content is then analysed instead of the guide's text. Ignored for the owner and for a guide shared in edit mode. Unknown URL: the guide's text is analysed.

saveToGuideboolean

Whether to save the content and the analysis score back to the guide (default: true)

scoreProgressiveboolean

Whether to compute the progressive score build-up curve (default: true). When false, progressiveScores is returned empty. Null is treated as "not provided", so the default applies.

includeEmbeddingboolean

Whether to compute the semantic embedding analysis, i.e. proximity and PCA (default: true). When false, the embeddingAnalysis key is omitted from the response. Null is treated as "not provided", so the default applies.

Response

Successful response with content analysis results. A call that saves nothing (saveToGuide: false, or a guide shared in read-only mode) and that repeats an identical request made less than 10 minutes ago is served from a cache, with the same body and without a new analysis.

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.