Pretty Urls

get

/pretty-urls/

The Pretty URLs method retrieves a list of user-friendly and SEO-optimized URL formats, referred to as Pretty URLs. Each Pretty URL entry provides a mapping from the original, non-optimized URL (old_path) to the optimized, user-friendly URL (new_path).

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Query parameters

argsstringOptional

Query parameter args used to filter results based on specific conditions.

created_datestring · date-timeOptional

Query parameter created_date used to filter results based on specific conditions.

func_initkwargsanyOptional

Query parameter func_initkwargs used to filter results based on specific conditions.

func_modulestringOptional

Query parameter func_module used to filter results based on specific conditions.

func_namestringOptional

Query parameter func_name used to filter results based on specific conditions.

idintegerOptional

Query parameter id used to filter results based on specific conditions.

id__gtintegerOptional

Filters records where id is greater than the given value.

id__gteintegerOptional

Filters records where id is greater than or equal to the given value.

id__ltintegerOptional

Filters records where id is less than the given value.

id__lteintegerOptional

Filters records where id is less than or equal to the given value.

kwargsanyOptional

Query parameter kwargs used to filter results based on specific conditions.

languagestringOptional

Query parameter language used to filter results based on specific conditions.

limitinteger · max: 1000Optional

Limits the number of records returned in a single page. The maximum is 1000. A higher value is capped at 1000 and the request still succeeds.

modified_datestring · date-timeOptional

Query parameter modified_date used to filter results based on specific conditions.

modified_date__gtstring · date-timeOptional

Filters records where modified_date is greater than the given value.

modified_date__gtestring · date-timeOptional

Filters records where modified_date is greater than or equal to the given value.

modified_date__ltstring · date-timeOptional

Filters records where modified_date is less than the given value.

modified_date__ltestring · date-timeOptional

Filters records where modified_date is less than or equal to the given value.

new_pathstringOptional

Query parameter new_path used to filter results based on specific conditions.

old_pathstringOptional

Query parameter old_path used to filter results based on specific conditions.

pageintegerOptional

Query parameter page used to filter results based on specific conditions.

parentintegerOptional

Query parameter parent used to filter results based on specific conditions.

query_paramsanyOptional

Query parameter query_params used to filter results based on specific conditions.

sortstringOptional

Query parameter sort used to filter results based on specific conditions.

viewnamestringOptional

Query parameter viewname used to filter results based on specific conditions.

Responses

200

Successful response for status code 200.

application/json

countintegerOptional

Numerical value representing quantity or total amount.

Example: 123

nextstring · uri · nullableOptional

This field defines the URL of the next page.

Example: http://api.example.org/accounts/?page=4

previousstring · uri · nullableOptional

This field defines the URL of the previous page.

Example: http://api.example.org/accounts/?page=2

get/pretty-urls/

GET /api/v1/remote/1/data-warehouse/pretty-urls/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

Successful response for status code 200.

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2",
  "results": [
    {
      "args": [
        "text"
      ],
      "created_date": "2026-01-01T00:00:00.000Z",
      "func_initkwargs": null,
      "func_module": "text",
      "func_name": "text",
      "id": 1,
      "kwargs": null,
      "language": "text",
      "modified_date": "2026-01-01T00:00:00.000Z",
      "new_path": "text",
      "old_path": "text",
      "parent": 1,
      "query_params": null,
      "viewname": "text"
    }
  ]
}

get

/pretty-urls/{id}/

The Pretty URLs method retrieves a list of user-friendly and SEO-optimized URL formats, referred to as Pretty URLs. Each Pretty URL entry provides a mapping from the original, non-optimized URL (old_path) to the optimized, user-friendly URL (new_path). This endpoint retrieves a specific record by its unique identifier.

Authorizations

AuthorizationstringRequired

Token-based authentication with required prefix "Token"

Path parameters

idintegerRequired

A unique integer value identifying this pretty url.

Responses

200

Successful response for status code 200.

application/json

argsstring[]Optional

The positional arguments parsed from the URL and passed to the view.

created_datestring · date-timeOptional

Timestamp indicating when the record was created.

func_initkwargsanyOptional

Keyword arguments passed to the view function.

func_modulestring · max: 256 · nullableOptional

The field defines the file name where the func_name is defined.

func_namestring · max: 64 · nullableOptional

The full name or label associated with the record.

idintegerOptional

Unique identifier for the record.

kwargsanyOptional

The field defines any additional parameters for the shipping option.

languagestring · max: 10 · nullableOptional

The field defines the language code.

modified_datestring · date-timeOptional

This field defines the last updated date.

new_pathstring · max: 512Optional

The field defines the URL to which the redirection will be made.

old_pathstring · max: 1024 · nullableOptional

The field defines the URL at which the redirection will occur.

parentinteger · nullableOptional

The field defines the ID of the associated basket item, if there is a related basket item.

query_paramsanyOptional

This field defines the query parameters included in the URL during the request.

viewnamestring · max: 64 · nullableOptional

The full name or label associated with the record.

404

Object not found.

application/json

get/pretty-urls/{id}/

GET /api/v1/remote/1/data-warehouse/pretty-urls/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "args": [
    "text"
  ],
  "created_date": "2026-01-01T00:00:00.000Z",
  "func_initkwargs": null,
  "func_module": "text",
  "func_name": "text",
  "id": 1,
  "kwargs": null,
  "language": "text",
  "modified_date": "2026-01-01T00:00:00.000Z",
  "new_path": "text",
  "old_path": "text",
  "parent": 1,
  "query_params": null,
  "viewname": "text"
}