> For the complete documentation index, see [llms.txt](https://help.netnut.io/netnut-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.netnut.io/netnut-documentation/resources/customers-api/unblocker.md).

# Unblocker

## POST /unblocker/usage

> Get Website Unblocker package usage data

```json
{"openapi":"3.0.1","info":{"title":"Customers api","version":"1.0"},"tags":[{"name":"Unblocker"}],"servers":[{"url":"https://customers-api.netnut.io/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UnblockerPlansInput":{"required":["end_date","plan_status","start_date"],"type":"object","properties":{"start_date":{"type":"string","description":"start date of the plan"},"end_date":{"type":"string","description":"end date of the plan"},"plan_status":{"type":"string","description":"the status of the plan (active, inactive, standby)"}}},"UnblockerPlanSuccess":{"required":["display_name","end_date","plan_status","start_date"],"type":"object","properties":{"end_date":{"type":"string","description":"end date of the plan"},"start_date":{"type":"string","description":"start date of the plan"},"plan_status":{"type":"boolean","description":"the status of the plan (active, inactive, standby)"},"display_name":{"type":"string","description":"display name of the plan"},"total_requests_used":{"type":"number","description":"usage of the plan in requests (will be only if the plan is in requests)"},"request_plan_size_M":{"type":"number","description":"request plan size in millions (will be only if the plan is in requests)"},"total_gb_used":{"type":"number","description":"usage of the plan in GB (will be only if the plan is in GB)"},"gb_plan_size":{"type":"number","description":"GB plan size in GB (will be only if the plan is in GB)"}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"is success"},"message":{"type":"string","description":"message"}}}}},"paths":{"/unblocker/usage":{"post":{"tags":["Unblocker"],"summary":"Get Website Unblocker package usage data","operationId":"getUnblockerUsage","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockerPlansInput"}}},"required":false},"responses":{"200":{"description":"Array of Plans","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockerPlanSuccess"}}}},"400":{"description":"fail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /unblocker/traffic

> Get Website Unblocker traffic data

```json
{"openapi":"3.0.1","info":{"title":"Customers api","version":"1.0"},"tags":[{"name":"Unblocker"}],"servers":[{"url":"https://customers-api.netnut.io/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"UnblockerTrafficInput":{"required":["endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"start date of the traffic"},"endDate":{"type":"string","description":"end date of the traffic"},"countries":{"type":"array","description":"traffic for a specific targeted country (array of 2 letter filter for specific countries)","items":{"type":"string"}},"splitByCountry":{"type":"boolean","description":"group by countries"},"splitByDate":{"type":"boolean","description":"group by date"}}},"UnblockerTrafficSuccess":{"required":["dataInBytes","product_type_id","statusCode200","statusCode401","statusCode403","statusCode404","statusCode407","statusCode502","statusCode503","statusCodeOther","successPercentage","successRequests"],"type":"object","properties":{"totalRequests":{"type":"number","description":"Total request for the group."},"successRequests":{"type":"number","description":"the number of successful requests for the group."},"dataInBytes":{"type":"number","description":"the total data transferred in bytes for the group."},"successPercentage":{"type":"number","description":"the success percentage of the requests for the group."},"date":{"type":"string","description":"the date of the group (will be only if the data is grouped by date)."},"statusCode200":{"type":"number","description":"the number of requests with status code 200 for the group."},"statusCode407":{"type":"number","description":"the number of requests with status code 407 for the group."},"statusCode502":{"type":"number","description":"the number of requests with status code 502 for the group."},"statusCode503":{"type":"number","description":"the number of requests with status code 503 for the group."},"statusCode404":{"type":"number","description":"the number of requests with status code 404 for the group."},"statusCode403":{"type":"number","description":"the number of requests with status code 403 for the group."},"statusCode401":{"type":"number","description":"the number of requests with status code 401 for the group."},"statusCodeOther":{"type":"number","description":"the number of requests with other status codes for the group."},"product_type_id":{"type":"number","description":"the product type id of the requests for the group."}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"is success"},"message":{"type":"string","description":"message"}}}}},"paths":{"/unblocker/traffic":{"post":{"tags":["Unblocker"],"summary":"Get Website Unblocker traffic data","operationId":"getUnblockerTraffic","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockerTrafficInput"}}},"required":false},"responses":{"200":{"description":"Array of Plans","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnblockerTrafficSuccess"}}}},"400":{"description":"fail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```

## POST /unblocker/traffic/domains

> Get Website Unblocker traffic by domain

```json
{"openapi":"3.0.1","info":{"title":"Customers api","version":"1.0"},"tags":[{"name":"Unblocker"}],"servers":[{"url":"https://customers-api.netnut.io/v1"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"GetTrafficByDomainRequest":{"required":["endDate","startDate"],"type":"object","properties":{"startDate":{"type":"string","description":"start date of the traffic"},"endDate":{"type":"string","description":"end date of the traffic"}}},"GetTrafficByDomainResponse":{"required":["traffic"],"type":"object","properties":{"traffic":{"type":"array","description":"Array of traffic data grouped by domain.","items":{"$ref":"#/components/schemas/DomainTrafficEntry"}}}},"DomainTrafficEntry":{"required":["dataInBytes","domain","successPercentage","successRequests","totalRequests"],"type":"object","properties":{"totalRequests":{"type":"number","description":"Total requests for the domain."},"successRequests":{"type":"number","description":"Successful requests for the domain."},"successPercentage":{"type":"number","description":"Success percentage for the domain."},"domain":{"type":"string","description":"The domain name."},"dataInBytes":{"type":"string","description":"Data transferred in bytes."}}},"ErrorResponse":{"type":"object","properties":{"success":{"type":"boolean","description":"is success"},"message":{"type":"string","description":"message"}}}}},"paths":{"/unblocker/traffic/domains":{"post":{"tags":["Unblocker"],"summary":"Get Website Unblocker traffic by domain","operationId":"getTrafficByDomain","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTrafficByDomainRequest"}}},"required":false},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetTrafficByDomainResponse"}}}},"400":{"description":"Fail","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}}
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.netnut.io/netnut-documentation/resources/customers-api/unblocker.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.