visibility

get/v1/projects/{project_id}/visibility

Request

  • Base URL: https://api.citeladder.com
  • URL: https://api.citeladder.com/v1/projects/{project_id}/visibility
  • Auth: HTTP bearer

Path parameters

project_idstring uuid required

Query parameters

audit_idstring uuid nullable
marketstring uuid nullable
enginestring nullable
baseline_idstring uuid nullable
selection_mode'latest' | 'run' | 'range'
fromstring date-time nullable
tostring date-time nullable
configuration_keystring nullable
cohort'core' | 'comparison' | 'all'

Response

Successful Response

project_idstring uuid required
audit_idstring uuid required
audit_status'draft' | 'validating' | 'queued' | 'running' | 'analyzing' | 'reporting' | 'completed' | 'partially_completed' | 'failed' | 'cancelled' required
analyzer_versionstring required
scoring_rule_versionstring required
cohort'core' | 'brand_diagnostic' | 'comparison' | 'commerce' | 'all' required
coverageobject required
total_completedinteger required
total_failedinteger required
visibility_scorenumber nullable required
visibility_ratenumber nullable
owned_citation_ratenumber nullable
prompt_performance_scorenumber nullable
comparison_keystring nullable
selection_mode'latest' | 'run' | 'range'
source_audit_idsstring[]
configuration_groupsobject
from_atstring nullable
to_atstring nullable
avg_positionnumber nullable required
created_atstring required

Changes

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