Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
75 changes: 72 additions & 3 deletions docs/APIs-and-SDKs/SDK-API/absmartly-collector-api.info.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,17 +9,86 @@ custom_edit_url: null
---

import ApiLogo from "@theme/ApiLogo";
import Heading from "@theme/Heading";
import SchemaTabs from "@theme/SchemaTabs";
import TabItem from "@theme/TabItem";
import Export from "@theme/ApiExplorer/Export";

<span className={"theme-doc-version-badge badge badge--secondary"}>Version: 1.0.0</span>
<span
className={"theme-doc-version-badge badge badge--secondary"}
children={"Version: 1.0.0"}
>
</span>

<h1 className={"openapi__heading"}>ABsmartly Collector API</h1>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"ABsmartly Collector API"}
>
</Heading>



An OpenAPI Specification that describes the ABsmartly Collector API. This API is mainly used when using ABsmartly in a language that does not yet have a supported SDK.

<div style={{"marginBottom":"2rem"}}><h2 id={"authentication"} style={{"marginBottom":"1rem"}}>Authentication</h2><SchemaTabs className={"openapi-tabs__security-schemes"}><TabItem label={"API Key: ApiKey"} value={"ApiKey"}><div><table><tbody><tr><th>Security Scheme Type:</th><td>apiKey</td></tr><tr><th>Header parameter name:</th><td>X-API-Key</td></tr></tbody></table></div></TabItem></SchemaTabs></div><div style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>Contact</h3><span>API Support: <a href={"mailto:api@absmartly.com"}>api@absmartly.com</a></span></div><div style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}><h3 style={{"marginBottom":"0.25rem"}}>License</h3></div>
<div
style={{"marginBottom":"2rem"}}
>
<Heading
id={"authentication"}
as={"h2"}
className={"openapi-tabs__heading"}
children={"Authentication"}
>
</Heading><SchemaTabs
className={"openapi-tabs__security-schemes"}
>
<TabItem
label={"API Key: ApiKey"}
value={"ApiKey"}
>




<div>
<table>
<tbody>
<tr>
<th>
Security Scheme Type:
</th><td>
apiKey
</td>
</tr><tr>
<th>
Header parameter name:
</th><td>
X-API-Key
</td>
</tr>
</tbody>
</table>
</div>
</TabItem>
</SchemaTabs>
</div><div
style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
Contact
</h3><span>
API Support: [api@absmartly.com](mailto:api@absmartly.com)
</span>
</div><div
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
>
<h3
style={{"marginBottom":"0.25rem"}}
>
License
</h3>
</div>

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"title":"Body"}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"responses":{"200":{"description":"Server is healthy"},"500":{"description":"Server is not healthy"}}}
47 changes: 31 additions & 16 deletions docs/APIs-and-SDKs/SDK-API/collector-health-check.api.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,34 +11,49 @@ info_path: docs/APIs-and-SDKs/SDK-API/absmartly-collector-api
custom_edit_url: null
---

import ApiTabs from "@theme/ApiTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import Markdown from "@theme/Markdown";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";
import Translate from "@docusaurus/Translate";

<h1 className={"openapi__heading"}>Check Service Health</h1>
<Heading
as={"h1"}
className={"openapi__heading"}
children={"Check Service Health"}
>
</Heading>

<MethodEndpoint method={"get"} path={"/healthy"}></MethodEndpoint>
<MethodEndpoint
method={"get"}
path={"/healthy"}
context={"endpoint"}
>

</MethodEndpoint>



A GET request to check that the service is running as expected.

<div><div><ApiTabs label={undefined} id={undefined}><TabItem label={"200"} value={"200"}><div>
<ParamsDetails>

</ParamsDetails>

Server is healthy
<RequestSchema
{...require("./collector-health-check.RequestSchema.json")}
>

</RequestSchema>

</div><div></div></TabItem><TabItem label={"500"} value={"500"}><div>
<StatusCodes
{...require("./collector-health-check.StatusCodes.json")}
>

</StatusCodes>

Server is not healthy

</div><div></div></TabItem></ApiTabs></div></div>

Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"parameters":[{"name":"X-Agent","in":"header","required":true,"description":"The User-Agent of your SDK.","example":"absmartly-Java-SDK v1.0.1","schema":{"type":"string"}},{"name":"X-Environment","in":"header","required":true,"description":"The environment in which you are running your experiments. These can be found and created in your ABsmartly Web Console settings.","example":"development","schema":{"type":"string"}},{"name":"X-Application","in":"header","required":true,"description":"The application in which you are running your experiments. These can be found and created in your ABsmartly Web Console settings.","example":"www","schema":{"type":"string"}},{"name":"X-Application-Version","in":"header","required":true,"description":"The application version which you are running your experiments on.","example":0,"schema":{"type":"integer","format":"int64"}}]}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"title":"Body","body":{"required":true,"description":"Units data for which to create the context and variant assignments. Unit types can be found and created in your ABsmartly Web Console settings.\n\n```json\n{\n \"type\": \"user_id\" // The name of the unit type\n \"uid\": \"4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408\" // The value of the unit that you are tracking.\n}\n```\n","content":{"application/json":{"schema":{"type":"object","required":["units"],"properties":{"units":{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"user_id"},"uid":{"type":"string","minLength":1,"maxLength":640,"example":"4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408"}},"title":"Unit"}}},"title":"ContextRequest"}}}}}
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","required":["units","assignments"],"properties":{"units":{"type":"array","items":{"type":"object","required":["type"],"properties":{"type":{"type":"string","example":"user_id"},"uid":{"type":"string","minLength":1,"maxLength":640,"example":"4a42766ca6313d26f49985e799ff4f3790fb86efa0fce46edb3ea8fbf1ea3408"}},"title":"Unit"}},"assignments":{"type":"array","items":{"type":"object","required":["id","iteration","name","variant","eligible","config"],"properties":{"id":{"type":"integer","format":"int32","minimum":0,"example":3},"iteration":{"type":"integer","format":"int32","minimum":0,"example":2},"name":{"type":"string","example":"exp_banner_color"},"variant":{"type":"integer","format":"int32","minimum":0,"maximum":127,"example":1},"eligible":{"type":"boolean","example":true},"audienceMismatch":{"type":"boolean","example":false},"originalVariant":{"type":"integer","format":"int32","minimum":0,"maximum":127,"example":1},"config":{"type":"string","nullable":true}},"title":"ExperimentAssignment"}}},"title":"ContextResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int64"},"message":{"type":"string"}},"title":"Error"}}}},"401":{"description":"Unauthorized"},"default":{"description":"Unexpected error","content":{"application/json":{"schema":{"type":"object","required":["code","message"],"properties":{"code":{"type":"integer","format":"int64"},"message":{"type":"string"}},"title":"Error"}}}}}}
Loading