RIPE Atlas Documentation

GET /credits/transactions/ ​

Get a historic income or expense transaction ​

GET: omit_serializer: true type: id: required: true type: integer type: required: true type: enum enum: ['admin', 'measurement', 'probe'] description: Transaction type reason: required: true type: string description: required: true type: string amount: required: true type: integer balance_before: required: true type: float balance_after: required: true type: float date: required: true type: date-time measurement_id: required: false type: integer measurement: required: false type: url samples: required: false type: integer probe_id: required: false type: integer probe: required: false type: url parameters_strategy: query: merge parameters:

  • name: date description: filter the transactions on the specified date, can be specified in the seconds since the epoch or in iso-8601 format type: string paramType: query
  • name: date__lt description: filter on date being less than value. type: integer paramType: query
  • name: date__lte description: filter on date being less than or equal to value. type: integer paramType: query
  • name: date__gte description: filter on date being greater than or equal to value. type: integer paramType: query
  • name: date__gt description: filter on date being greater than value. type: integer paramType: query
  • name: sort description: sorting transaction (only by date) type: enum enum: ['date', '-date'] defaultValue: 'date' paramType: query
  • name: type description: filter transactions by type type: enum enum: ['admin', 'measurement', 'probe'] paramType: query
  • name: page_size description: Set responce size type: integer paramType: query

GET /credits/transactions/ — format ​

GET /api/v2/credits/transactions/​

Get a historic income or expense transaction

GET:
omit_serializer: true
type:
id:
required: true
type: integer
type:
required: true
type: enum
enum: ['admin', 'measurement', 'probe']
description: Transaction type
reason:
required: true
type: string
description:
required: true
type: string
amount:
required: true
type: integer
balance_before:
required: true
type: float
balance_after:
required: true
type: float
date:
required: true
type: date-time
measurement_id:
required: false
type: integer
measurement:
required: false
type: url
samples:
required: false
type: integer
probe_id:
required: false
type: integer
probe:
required: false
type: url

parameters_strategy:
query: merge
parameters:

  • name: date
    description: >
    filter the transactions on the specified date, can be
    specified in the seconds since the epoch or in iso-8601
    format
    type: string
    paramType: query
  • name: date__lt
    description: filter on date being less than value.
    type: integer
    paramType: query
  • name: date__lte
    description: filter on date being less than or equal to value.
    type: integer
    paramType: query
  • name: date__gte
    description: filter on date being greater than or equal to value.
    type: integer
    paramType: query
  • name: date__gt
    description: filter on date being greater than value.
    type: integer
    paramType: query
  • name: sort
    description: sorting transaction (only by date)
    type: enum
    enum: ['date', '-date']
    defaultValue: 'date'
    paramType: query
  • name: type
    description: filter transactions by type
    type: enum
    enum: ['admin', 'measurement', 'probe']
    paramType: query
  • name: page_size
    description: Set responce size
    type: integer
    paramType: query
Try it out

Playground​

Authorization
Variables
Key
Value
Authorizations

Authorizations​

api-key
Type
API Key (header: Authorization)
or
ripe-access
Type
API Key (cookie: crowd.token_key)
Parameters

Query Parameters

format
Type
string
Valid values
"json""txt"
Responses

Responses​

No response body

Samples