Get OpenAPI Spec

GET

https://api.zignallabs.com/newsroom/docs

GET

/newsroom/docs

$ curl https://api.zignallabs.com/newsroom/docs \
>      -H "Content-Type: application/json"

200Retrieved

1 {
2   "components": {
3     "securitySchemes": {}
4   },
5   "info": {
6     "description": "The Zignal Data API is a RESTful data serving layer. Allows you to access all your Mentions data, metadata and metrics available within Zignal platform and integrate it into your other business applications or products.",
7     "title": "Data API - Newsroom",
8     "version": "2.0.0"
9   },
10   "openapi": "3.0.3",
11   "paths": {
12     "/newsroom/docs": {
13       "get": {
14         "description": "Returns the OpenAPI 3.0 specification for the Newsroom API as a YAML document.\n",
15         "operationId": "getNewsroomDocs",
16         "responses": {
17           "200": {
18             "content": {
19               "application/x-yaml": {
20                 "schema": {
21                   "type": "string"
22                 }
23               }
24             },
25             "description": "Successful response"
26           }
27         },
28         "security": [
29           {
30             "api-key-security": []
31           }
32         ],
33         "summary": "Get OpenAPI Spec",
34         "tags": [
35           "Documentation"
36         ]
37       }
38     }
39   },
40   "servers": [
41     {
42       "url": "https://api.zignallabs.com"
43     }
44   ],
45   "tags": []
46 }

Returns the OpenAPI 3.0 specification for the Newsroom API as a YAML document.

Response

Successful response