1. 42 Api 2.0
  2. Patronages reports
  3. graph

GET /v2/patronages_reports/graph(/on/:field(/by/:interval))
Return grouped temporal data on patronages reports

Count all occurences on a particular field (default on created_at) by a particular period, starting from the first occurence to now.

settings Params

Param name Description
field optional . Must be one of: created_at, updated_at, begin_at, validated_at.

The date field to graph on. Default to created_at.
interval optional . Must be one of: day, week, month, quarter, year, hour_of_day, day_of_week, day_of_month, month_of_year.

The interval to graph by. Default to month_of_year.
sort optional . Must be one of: id, user_id, begin_at, created_at, updated_at, patronage_id, report_id, validated_at.

The sort field. Sorted by created_at desc, id desc by default.

Example:

To sort on patronages reports on the fields report_id on a descending order and validated_at on a ascending order: 

...&sort=-report_id,validated_at
filter optional . Must be one of: id, user_id, begin_at, created_at, updated_at, patronage_id, report_id, validated_at, future, validated.

Filtering on one or more fields

Example:

To filter on patronages reports with the id field matching a_value or another_value: 

...&filter[id]=a_value,another_value

Filterable fields:
  • id (standard field)
  • user_id (standard field)
  • begin_at (standard field)
  • created_at (standard field)
  • updated_at (standard field)
  • patronage_id (standard field)
  • report_id (standard field)
  • validated_at (standard field)
  • future : Return only patronages reports which begins in the future. Can be one of: true, false
  • validated (standard field)
range optional . Must be one of: id, user_id, begin_at, created_at, updated_at, patronage_id, report_id, validated_at.

Select on a particular range

Example:

To range on patronages reports with the validated_at field between min_value and max_value: 

...&range[validated_at]=min_value,max_value

Rangeable fields:
  • id
  • user_id
  • begin_at
  • created_at
  • updated_at
  • patronage_id
  • report_id
  • validated_at 
GET /v2/patronages_reports/graph/on/created_at/by/day
200
{
  "2017-11-22": 124
}
curl  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" "https://api.intra.42.fr/v2/patronages_reports/graph/on/created_at/by/day"

{
  "2017-11-22": 124
}
require "oauth2"
UID = "Your application uid"
SECRET = "Your application secret"
client = OAuth2::Client.new(UID, SECRET, site: "https://api.intra.42.fr")
token = client.client_credentials.get_token

response = token.get("/v2/patronages_reports/graph/on/created_at/by/day")
response.status
# => 200
response.parsed
# => {"2017-11-22"=>124}