List report templates

Retrieve a list of available report templates.

Use limit and offset query parameters to paginate results.

GET /billing/org/v1/reports/templates

List report templates

cURL

curl --request GET \
  --url https://api.gcore.com/billing/org/v1/reports/templates \
  --header 'Authorization: <api-key>'

200

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "code": "<string>",
      "name_en": "<string>",
      "description": "<string>",
      "parameters": {
        "parameters": [
          {
            "name": "<string>",
            "required": true,
            "type": "<string>",
            "format": "<string>",
            "description": "<string>",
            "enum": [
              "<string>"
            ]
          }
        ]
      }
    }
  ],
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Query Parameters

code · string

code__icontains · string

code__in · string[]

Multiple values may be separated by commas.

comment__icontains · string

description__icontains · string

id · integer

id__gt · integer

id__in · integer[]

Multiple values may be separated by commas.

id__lt · integer

limit · integer

Number of results to return per page. Maximum is 100. Default is 20.

name_en__icontains · string

offset · integer

The initial index from which to return the results.

order_by · enum<string>[]

Ordering of the results.

For ascending sort order use field.asc, for descending sort order use field.desc.

For sorting by multiple parameters write them as comma separated string: client_id.asc,id.desc.

Final stable tiebreak ordering is added except when pk sorting used.

• id.asc - Id
• id.desc - Id (descending)
• code.asc - Code
• code.desc - Code (descending)
• name_en.asc - Name en
• name_en.desc - Name en (descending)
• description.asc - Description
• description.desc - Description (descending)
• parameters.asc - Parameters
• parameters.desc - Parameters (descending)

Available options: code.asc, code.desc, description.asc, description.desc, id.asc, id.desc, name_en.asc, name_en.desc, parameters.asc, parameters.desc

ordering · enum<string>[]

Ordering of the results.

This field is left for compatibility and can be deprecated in future versions. Use order_by instead.

Default sort order is ascending. Put - before value for descending sort order: -id.

For sorting by multiple parameters write them as comma separated string: -client_id,id.

Final stable tiebreak ordering is added except when pk sorting used.

• id - Id
• -id - Id (descending)
• code - Code
• -code - Code (descending)
• name_en - Name en
• -name_en - Name en (descending)
• description - Description
• -description - Description (descending)
• parameters - Parameters
• -parameters - Parameters (descending)

Available options: -code, -description, -id, -name_en, -parameters, code, description, id, name_en, parameters

Response

200

application/json

Request successful.

count · integer · required

Example:

123

results · object[] · required

Show child attributes

next · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=400&limit=100"

previous · string<uri> | null

Example:

"http://api.example.org/accounts/?offset=200&limit=100"