Skip to main content

WeeksAndWeights

The weeks and the weightings a survey accepts in a calculation, in the order of the survey. Send the id of a week in weeks, and an item of weights as weight, of a table or of a survey wave of a SOURCES axis.

weeks object[]required

Weeks of the survey. Always present: empty when the survey has no weeks.

  • Array [
  • idstring

    Identifier of the week, YYYY/WW: the value to send in weeks.

    yearinteger<int32>

    Year of the week.

    weekinteger<int32>

    Number of the week in its year.

    startDatestring<date-time>

    First day of the week, its Monday, as an ISO 8601 date-time in UTC. Midnight in the time zone of the platform can fall on the day before in UTC.

    endDatestring<date-time>

    Last day of the week, its Sunday, as an ISO 8601 date-time in UTC, like startDate.

  • ]
  • weights object[]required

    Weightings of the survey. Always present: empty when the survey has no weightings.

  • Array [
  • idstringrequired

    Identifier of the weighting.

    labelstring

    Name of the weighting, as the survey defines it. It is not translated.

    universeinteger<int32>

    Universe of the weighting. It can be missing.

    isDefaultboolean

    Whether it is the default weighting of the survey, the one used when a table is sent without a weighting.

  • ]
  • WeeksAndWeights
    {
    "weeks": [
    {
    "id": "string",
    "year": 0,
    "week": 0,
    "startDate": "2024-07-29T15:51:28.071Z",
    "endDate": "2024-07-29T15:51:28.071Z"
    }
    ],
    "weights": [
    {
    "id": "string",
    "label": "string",
    "universe": 0,
    "isDefault": true
    }
    ]
    }