POST /content-graphs/{cg_instance_id}/query

1 min

POST

https://api.cmp.optimizely.com/v3/content-graphs/{cg_instance_id}/query

Experimental Run a GraphQL query against a content graph instance. Get the cg_instance_id from GET /content-graphs.

Use this to check whether a given asset has synced to the graph, by querying for its identifier and seeing whether the graph returns it.

Reading the response. A 200 carries the graph's JSON payload (data, and extensions when present) passed through unchanged. If the graph rejects a well-formed query, the endpoint returns the graph's own 4xx status with its GraphQL errors body (for example 429 when the graph rate-limits). A 502 means the content graph is unavailable or returned a server error, and a 504 means it could not be reached in time — both are transient, so retry. A 500 is a server-side failure on our end and, unlike 502/504, will not be resolved by retrying.

cg_instance_idstringUnique identifier of the content graph instance

acceptstringGenerated from available response content types

bodyobjectGraphQL query to run against the content graph instance

200Query reached the content graph and succeeded. The body is the graph's JSON response, passed through unchanged.

400The request was invalid (for example a missing <code>query</code>), or the graph rejected a well-formed query. When it originates from the graph, the body is the graph's GraphQL <code>errors</code> payload.

401Authorization error

403Permission error

404Not found error

429The content graph rate-limited the request. Passed through with the graph's status and body unchanged. Retry after a short delay.

502The content graph is unavailable or returned an error that could not be passed through to the caller. Transient — retry.

504The content graph could not be reached within the timeout. Transient — retry.

curl --request POST \
     --url https://api.cmp.optimizely.com/v3/content-graphs/{cg_instance_id}/query \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{
     "query": "query MyQuery($after: String) { cmp_PublicImageAsset(limit: 50, cursor: $after) { total items { Id } cursor } }"
     }'