ვერსია 1 - პერიოდული შედარების ანალიზი

გამოქვეყნებულია: 29 აპრ 2015ბოლო განახლება: 02 ნოემ 2015

პერიოდულ შედარებაში მონაცემების გაანალიზება. ანალიზის შედეგების მისაღებად პერიოდული შედარებები  API-ს მეთოდის გამოყენებით შეისწავლიან გვერდებს ამ ვებ-საიტზე.

URL

ამ მეთოდის გამოძახებისთვის გამოიყენეთ HTTP GET მოთხოვნა შემდეგი URL-სთვის:

http://data.unicef.ge/[locale]/api/v1/time_series_analysis

სადაც:

  • [locale] = ენის ადგილი, რომელშიც გსურთ მონაცემების მიღება (ამ დროისთვის ka ქართულად ან en ინგლისურად)

აუილებელი პარამეტრები

მოთხოვნა უნდა შეიცავდეს შემდეგ პარამეტრებს:

პარამეტრიაღწერა
access_token ყველა მოთხოვნა უნდა შეიცავდეს დაშვების_გასაღებს. თქვენ მარტივად და უფასოდ შეგიძლიათ მიიღოთ დაშვების გასაღები ამ მისამართზე გადასვლით.
time_series_id პერიოდული შედარების ID
question_code პერიოდული შედარების კითხვის კოდი.

 

არჩევითი პარამეტრები 

ქვემოთ მოცემული პარამეტრები არჩევითია გამოძახებისთვის.

ParameterDescription
language ენის კოდი, რომელშიც დაბრუნდება მონაცემთა ცხრილის ინფორმაცია (მაგ. en ინგლისური ენისთვის). იმ შემთხვევაში, თუ language არ არის მოცემული, ცხრილისთვის გამოყენებული იქნება ძირითადი ენა.
filter_by_code კითხვის კოდი, რათა ანალიზი გაფილტროს
can_exclude ბულის დროშა, რომელიც მიუითითებს, რომ თუ პასუხის გამოტოვება შესაძლებელია, ის უნდა იყოს გამოტოვებული (მთავარი მნიშვნელობა მცდარია)
with_title ბულის დროშა, რომელიც მიუითითებს, რომ სახელები უნდა შეიცავდნენ მონაცემების შეჯამებას (მთავარი მნიშვნელობა მცდარია).
with_chart_data ბულის დროშა, რომელიც მიუითითებს, რომ შედეგები უნდა შეიცავდნენ დაფორმატებული მონაცემების Highchart გრაფიკში გადაყვანას (მთავარი მნიშვნელობა მცდარია).

რას მიიღებთ

დაბრუნებული ობიექტი იქნება პერიოდული შედარების ანალიზის JSON ობიექტი შემდეგი ინფორმაციით:

პარამეტრიაღწერა
time_series

ობიექტი ქემოთ მოცემული მნიშვნელობებით:

  • id - იმ პერიოდული შედარების ID, რომელიც გაანალიზდა
  • title - იმ პერიოდული შედარების სახელი, რომელიც გაანალიზდა
datasets

ცხრილის მასივი, რომელიც მოცემულია დროის სერიაში შემდეგი ინფორმაციით:

  • id - ცხრილის ID
  • title - ცხრილის დასახელება
  • label - ცხრილის ეტიკეტი მოცემულ დროის სერიაში
question

ობიექტი ქვემოთ მოცემული მნიშვნელობებით:

  • code - იმ კითხვის კოდი, რომელის გაანალიზდა
  • original_code - იმ კითხვის თავდაპირველი_კოდი, რომელიც გაანალიზდა
  • text - იმ კითხვის ტექსტი, რომელიც გაანალიზდა
  • notes - კითხვის შესახებ რაიმე სპეციალური შენიშვნა
  • is_mappable - ბულის დროშა, რომელიც მიუითითებს არის თუ არა ეს კითხკვა დაკავშირებული რუკის ფორმებთან.
  • answers - მოცემული ინფორმაციის მასივი:
    • value - პასუხის მნიშვნელობა
    • text - პასუხის ტექსტი
    • can_exclude - ბულის დროშა, რომელიც მიუითითებს შეიძლება თუ არა ანალიზიდან ამ პასუხის გამოტოვება.
    • sort_order - თანმიმდევრობა, სადაც პასუხები უნდა გამოისახონ.
filtered_by

მხოლოდ მაშინ, თუ filtered_by_code იყო მოწოდებული. ობიექტი ქვემოთ მოცემული მნიშვნელობებით:

  • code - იმ კითხვის კოდი, რომელის გაანალიზდა
  • original_code - იმ კითხვის თავდაპირველი_კოდი, რომელიც გაანალიზდა
  • text - იმ კითხვის ტექსტი, რომელიც გაანალიზდა
  • notes - კითხვის შესახებ რაიმე სპეციალური შენიშვნა
  • is_mappable - ბულის დროშა, რომელიც მიუითითებს არის თუ არა ეს კითხკვა დაკავშირებული რუკის ფორმებთან
  • answers - მოცემული ინფორმაციის მასივი:
    • value - პასუხის მნიშვნელობა
    • text - პასუხის ტექსტი
    • can_exclude - ბულის დროშა, რომელიც მიუითითებს შეიძლება თუ არა ანალიზიდან ამ პასუხის გამოტოვება.
    • sort_order - თანმიმდევრობა, სადაც პასუხები უნდა გამოისახონ.
analysis_type

მიუთითებს რა ტიპის ანალიზი შესრულდა:

  • time_series - დროის სერია აანალიზებს question_code შექმნას
results

ობიექტი ქვემოთ რომელიც მოიცავ ანალიზის შედეგებს მოცემული ინფორმაციით:

  • total_responses - იმ ადამიანების რაოდენობა, რომლებიც გამოეხმაურნენ ამ შეკითხვას
  • analysis - თითოეული შეკითხვის პასუხზე შედეგების მასივი:
    • answer_value - პასუხის მნიშვნელობა
    • answer_text - პასუხის ტექსტი
    • count - იმ ადამიანთა რაოდენობა, რომლებმაც გასცეს ეს პასუხი
    • percent - პასუხ გაცემული ადამიანების პროცენტული შედარება მთლიან გამოხმაურებასთან.

თუ filtered_by_code იყო მოწოდებული, ანალიზების შედეგებს ექნებათ შემდეგი ინფორმაცია:

  • filtered_analysis - კითხვების ფილტრში დაჯგუფებული შედეგების მასივი, შემდეგი ინფორმაციით:
    • filter_answer_value - კითხვებით გაფილტრული პასუხების მნიშვნელობა
    • filter_answer_text - კითხვებით გაფილტრული პასუხების ტექსტი 
    • filter_results - თითოეულ შეკითხვაზე პასუხის შედეგების მასივი, რომელიც აგრეთვე ეხმიანება პასუხების ფილტს, შემდეგი ინფორმაციით:
      • total_responses - რაოდენობა, რომელიც აჩვენებს რამდენმა ადამიანმა უპასუხა ამ კითხვას და უპასუხა გაფილტრულ პასუხს
      • analysis - თითოეულ შეკითხვაზე პასუხის შედეგის მასივი, შემდეგი ინფორმაციით:
        • answer_value - შეკითხვის პასუხის მნიშვნელობა
        • answer_text - შეკითხვის პასუხის ტექსტი
        • count - იმ ადამიანების რაოდენობა, რომლებიც გაიფილტრნენ პასუხით და კითხვის პასუხით 
        • percent - იმ ადამიანების პროცენტული შედარება მთლიან გამოხმაურებასთან, რომლებიც გაიფილტრნენ პასუხის და კითხვის პასუხით
chart

მხოლოდ, თუ with_chart_data იყო მართალი. ობიექტი შემდეგი მნიშვნელობებით:

embed_id -  უნიკალური ID, რომელიც შეიძლება გამოყენებულ იქნას ვებ-საიტზე ამ გრაფიკის ჩასასმელად შემდეგი url-ის გამოყენებით: http://data.unicef.ge/en/embed/v1/embed_id, სადაც embed_id არის უნიკალური ID.

  • data - მონაცემების წერტილების მასივი შემდეგი ინფორმაციით:
    • name - the answer_text value from the results
    • data - თითოეული ფორმისთვის მონაცემების წერტილების მასივი შემდეგი ინფორმაციით
      • results-დან percent-ის მნიშვნელობა
      • countresults-დან count-ის მნიშვნელობა

მაგალითები

მაგალითი 1

მაგალითისთვის მოცემულია გენდერის ანალიზის შედეგები, შემდეგი url-ით:

http://data.unicef.ge/en/api/v1/time_series_analysis?access_token=123456789&time_series_id=1111111111&question_code=gender
{
  time_series: 
  {
    id: "1111111111",
    title: "This is a time series!"
  },
  datasets:[
    {
      id: "11112009",
      title: "Dataset from 2009"
      label: "2009"
    },
    {
      id: "11112011",
      title: "Dataset from 2011"
      label: "2011"
    },
    {
      id: "11112013",
      title: "Dataset from 2013"
      label: "2013"
    }
  ],
  question: 
  {
    code: "gender",
    original_code: "GENDER",
    text: "What is your gender?",
    is_mappable: false,
    answers:[
      {
        value: "1",
        text: "Male",
        can_exclude: false,
        sort_order: 1
      },
      {
        value: "2",
        text: "Female",
        can_exclude: false,
        sort_order: 2
      },
      {
        value: "3",
        text: "Refuse to Answer",
        can_exclude: true,
        sort_order: 3
      }
    ]
  },
  analysis_type: "time_series",
  results:
  {
    total_responses:[
      {
        dataset_label: '2009',
        dataset_title: 'Dataset from 2009',
        count: 150
      },
      {
        dataset_label: '2011',
        dataset_title: 'Dataset from 2011',
        count: 160
      },
      {
        dataset_label: '2013',
        dataset_title: 'Dataset from 2013',
        count: 200
      }
    ],
    analysis: [
      {
        answer_value: '1',
        answer_text: 'Male',
        dataset_results:[
          {
            dataset_label: '2009',
            dataset_title: 'Dataset from 2009',
            count: 80,
            percent: 53.33
          },
          {
            dataset_label: '2011',
            dataset_title: 'Dataset from 2011',
            count: 85,
            percent: 53.13
          },
          {
            dataset_label: '2013',
            dataset_title: 'Dataset from 2013',
            count: 100,
            percent: 50
          }
        ]
      },
      {
        answer_value: '2',
        answer_text: 'Female',
        dataset_results:[
          {
            dataset_label: '2009',
            dataset_title: 'Dataset from 2009',
            count: 68,
            percent: 45.33
          },
          {
            dataset_label: '2011',
            dataset_title: 'Dataset from 2011',
            count: 75,
            percent: 46.88
          },
          {
            dataset_label: '2013',
            dataset_title: 'Dataset from 2013',
            count: 95,
            percent: 47.5
          }
        ]
      },
      {
        answer_value: '3',
        answer_text: 'Refuse to Answer',
        dataset_results:[
          {
            dataset_label: '2009',
            dataset_title: 'Dataset from 2009',
            count: 2,
            percent: 1.33
          },
          {
            dataset_label: '2011',
            dataset_title: 'Dataset from 2011',
            count: 0,
            percent: 0
          },
          {
            dataset_label: '2013',
            dataset_title: 'Dataset from 2013',
            count: 5,
            percent: 2.5
          }
        ]
      }
    ]
  }
}

მაგალითი 2

მაგალითისთვის მოცემულია გენდერის ანალიზის შედეგები, Live-ს მიხედვით გაფილტრული:

http://data.unicef.ge/en/api/v1/time_series_analysis?access_token=123456789&time_series_id=1111111111&question_code=gender&filtered_by_code=live
{
  time_series: 
  {
    id: "1111111111",
    title: "This is a time series!"
  },
  datasets:[
    {
      id: "11112009",
      title: "Dataset from 2009"
      label: "2009"
    },
    {
      id: "11112011",
      title: "Dataset from 2011"
      label: "2011"
    },
    {
      id: "11112013",
      title: "Dataset from 2013"
      label: "2013"
    }
  ],
  question: 
  {
    code: "gender",
    original_code: "GENDER",
    text: "What is your gender?",
    is_mappable: false,
    answers:[
      {
        value: "1",
        text: "Male",
        can_exclude: false,
        sort_order: 1
      },
      {
        value: "2",
        text: "Female",
        can_exclude: false,
        sort_order: 2
      },
      {
        value: "3",
        text: "Refuse to Answer",
        can_exclude: true,
        sort_order: 3
      }
    ]
  },
  filtered_by:
  {
    code: "live",
    original_code: "LIVE",
    text: "Where do you live?",
    is_mappable: false,
    answers:[
      {
        value: "1",
        text: "Tbilisi",
        can_exclude: false,
        sort_order: 1
      },
      {
        value: "2",
        text: "London",
        can_exclude: false,
        sort_order: 2
      },
      {
        value: "3",
        text: "New York City",
        can_exclude: false,
        sort_order: 3
      }
    ]
  },
  analysis_type: "time_series",
  results:
  {
    filter_analysis: [
      {
        filter_answer_value: '1',
        fitler_answer_text: 'Tbilisi',
        filter_results: {
          total_responses:[
            {
              dataset_label: '2009',
              dataset_title: 'Dataset from 2009',
              count: 15
            },
            {
              dataset_label: '2011',
              dataset_title: 'Dataset from 2011',
              count: 16
            },
            {
              dataset_label: '2013',
              dataset_title: 'Dataset from 2013',
              count: 20
            }
          ],
          analysis: [
            {
              answer_value: '1',
              answer_text: 'Male',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 8,
                  percent: 53.33
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 9,
                  percent: 56.25
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 10,
                  percent: 50
                }
              ]
            },
            {
              answer_value: '2',
              answer_text: 'Female',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 7,
                  percent: 46.67
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 7,
                  percent: 43.75
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 10,
                  percent: 50
                }
              ]
            },
            {
              answer_value: '3',
              answer_text: 'Refuse to Answer',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 0,
                  percent: 0
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 0,
                  percent: 0
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 0,
                  percent: 0
                }
              ]
            }
          ]
        }
      },
      {
        filter_answer_value: '2',
        fitler_answer_text: 'London',
        filter_results: {
          total_responses:[
            {
              dataset_label: '2009',
              dataset_title: 'Dataset from 2009',
              count: 60
            },
            {
              dataset_label: '2011',
              dataset_title: 'Dataset from 2011',
              count: 80
            },
            {
              dataset_label: '2013',
              dataset_title: 'Dataset from 2013',
              count: 75
            }
          ],
          analysis: [
            {
              answer_value: '1',
              answer_text: 'Male',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 35,
                  percent: 58.33
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 42,
                  percent: 52.5
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 40,
                  percent: 53.33
                }
              ]
            },
            {
              answer_value: '2',
              answer_text: 'Female',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 25,
                  percent: 41.67
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 38,
                  percent: 47.5
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 35,
                  percent: 46.67
                }
              ]
            },
            {
              answer_value: '3',
              answer_text: 'Refuse to Answer',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 0,
                  percent: 0
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 0,
                  percent: 0
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 0,
                  percent: 0
                }
              ]
            }
          ]
        }
      },      
      {
        filter_answer_value: '3',
        fitler_answer_text: 'New York City',
        filter_results: {
          total_responses:[
            {
              dataset_label: '2009',
              dataset_title: 'Dataset from 2009',
              count: 75
            },
            {
              dataset_label: '2011',
              dataset_title: 'Dataset from 2011',
              count: 80
            },
            {
              dataset_label: '2013',
              dataset_title: 'Dataset from 2013',
              count: 100
            }
          ],
          analysis: [
            {
              answer_value: '1',
              answer_text: 'Male',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 37,
                  percent: 49.33
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 40,
                  percent: 50
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 50,
                  percent: 50
                }
              ]
            },
            {
              answer_value: '2',
              answer_text: 'Female',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 36,
                  percent: 48
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 40,
                  percent: 50
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 45,
                  percent: 45
                }
              ]
            },
            {
              answer_value: '3',
              answer_text: 'Refuse to Answer',
              dataset_results:[
                {
                  dataset_label: '2009',
                  dataset_title: 'Dataset from 2009',
                  count: 2,
                  percent: 2.67
                },
                {
                  dataset_label: '2011',
                  dataset_title: 'Dataset from 2011',
                  count: 0,
                  percent: 0
                },
                {
                  dataset_label: '2013',
                  dataset_title: 'Dataset from 2013',
                  count: 5,
                  percent: 5
                }
              ]
            }
          ]
        }
      }
    ]
  }
}