HydraCore
API by router

Platform internal

Get Customer Context

GET
/internal/v1/instances/{instance_id}/customer-context/{customer_id}

Path Parameters

instance_id*Instance Id
Formatuuid
customer_id*Customer Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
customer_id*Customer Id
Formatuuid
primary_site_id?|null
sites*array<>
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/customer-context/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",  "primary_site_id": "e4832575-3d0f-4b4d-8fd3-3db114f512f5",  "sites": [    {      "config_id": "d1d31429-d888-4f1c-b9c1-4e842f9bce5b",      "content_mode": "string",      "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e",      "is_primary": true,      "status": "string"    }  ]}

Get Site Analytics

GET
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/analytics

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Query Parameters

period?Period
Default7

Response Body

Successful Response

application/json
  1. response
daily_views?array<>
device_breakdown?
period_days*Period Days
top_pages*array<>
total_views*Total Views
unique_sessions*Unique Sessions
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/analytics'
Example Response
{  "daily_views": [    {}  ],  "device_breakdown": {},  "period_days": 0,  "top_pages": [    {}  ],  "total_views": 0,  "unique_sessions": 0}

List Site Forms

GET
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/forms

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Query Parameters

unread_only?Unread Only
Defaultfalse

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms'
Example Response
[  {    "created_at": "2019-08-24T14:15:22Z",    "form_data": {},    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "is_read": true,    "page_slug": "string",    "submitter_email": "string"  }]

Get Site Form Stats

GET
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/forms/stats

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
total*Total
unread*Unread
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/forms/stats'
Example Response
{  "total": 0,  "unread": 0}

List Site Media

GET
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/media

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/media'
Example Response
null

Get Media Upload Url

POST
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/media/upload-url

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Request Body

application/json
  1. body
content_type*Content Type
filename*Filename
Lengthlength <= 255

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/media/upload-url' \  -H 'Content-Type: application/json' \  -d '{  "content_type": "string",  "filename": "string"}'
Example Response
null

List Site Pages

GET
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/pages

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
[index: integer]?
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages'
Example Response
[  {    "content_html": "string",    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "metadata_json": {},    "slug": "string",    "sort_order": 0,    "status": "draft",    "title": "string",    "updated_at": "2019-08-24T14:15:22Z"  }]

Create Site Page

POST
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/pages

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Request Body

application/json
  1. body
content_html?Content Html
Default""
slug*Slug
Lengthlength <= 200
title*Title
Lengthlength <= 300

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages' \  -H 'Content-Type: application/json' \  -d '{  "slug": "string",  "title": "string"}'
Example Response
null

Get Site Page

GET
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/pages/{slug}

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid
slug*Slug

Response Body

Successful Response

application/json
  1. response
content_html*Content Html
id*Id
Formatuuid
metadata_json?
Default{}
slug*Slug
sort_order?Sort Order
Default0
status?Status
Default"draft"
title*Title
updated_at*Updated At
Formatdate-time
Example Request
curl -X GET 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages/string'
Example Response
{  "content_html": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "metadata_json": {},  "slug": "string",  "sort_order": 0,  "status": "draft",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Delete Site Page

DELETE
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/pages/{slug}

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid
slug*Slug

Response Body

Successful Response

response?unknownapplication/json
Example Request
curl -X DELETE 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages/string'
Example Response
null

Update Site Page

PUT
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/pages/{slug}

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid
slug*Slug

Request Body

application/json
  1. body
content_html?string|null
metadata_json?|null
sort_order?integer|null
status?|null
title?|null

Response Body

Successful Response

application/json
  1. response
content_html*Content Html
id*Id
Formatuuid
metadata_json?
Default{}
slug*Slug
sort_order?Sort Order
Default0
status?Status
Default"draft"
title*Title
updated_at*Updated At
Formatdate-time
Example Request
curl -X PUT 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/pages/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "content_html": "string",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "metadata_json": {},  "slug": "string",  "sort_order": 0,  "status": "draft",  "title": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Publish Site

POST
/internal/v1/instances/{instance_id}/platform/sites/{config_id}/publish

Path Parameters

instance_id*Instance Id
Formatuuid
config_id*Config Id
Formatuuid

Response Body

Successful Response

application/json
  1. response
message*Message
status*Status
task_id?string|null
Example Request
curl -X POST 'https://example.com/internal/v1/instances/497f6eca-6276-4993-bfeb-53cbbbba6f08/platform/sites/497f6eca-6276-4993-bfeb-53cbbbba6f08/publish'
Example Response
{  "message": "string",  "status": "string",  "task_id": "string"}

Platform forms public

Previous Page

Plugins

Next Page