Motimate: Genel API Kullanarak Rapor Oluşturma

Kurs tamamlama verilerinin aşağıdaki yollarla paylaşılmasına ek olarak Motimate xAPIayrıca Motimate Public API'den Excel dosyalarının çıkarılmasını da destekliyoruz. Bu Excel raporları, daha önce aşağıda oluşturulan Rapor şablonlarına dayanmaktadır Rapor Oluşturma Motimate'teki İçgörüler altındaki özellik.

İşte başlamadan önce bazı faydalı bilgiler:

İlgili üç Motimate Genel API işlevi şunlardır:

• GET /insights/learnings/report_templates
   
• POSTA /insights/learnings/report_requests
   
• GET /insights/learnings/report_requests/{id}

Genel API ile bir rapor oluşturmadan önce, Rapor Oluştur'da bir rapor şablonunun zaten oluşturulmuş olduğundan(buradaki kılavuza bakın) ve hangi şablon(lar)dan rapor(lar) oluşturacağınızı bildiğinizden emin olun. Bunun hazır olması koşuluyla, bir rapor oluşturma süreci üç adım gerektirecektir:

Adım 1: Rapor şablonlarının bir listesini alın:

Komut: GET /insights/learnings/report_templates

Örnek Yanıt:

{
  "data": [
    {
      **"id": "abc86b82-029a-4b74-9690-4ab607f3eafe "**,
      "name": "Rapor Testi",
      "description": "Genel API amacı için test",
      "last_status": "uploading",
      "last_generated_at": null,
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-01T15:41:26.98349+01:00",
      "user": {
        "name": "John Doe"
      }
    }
  ]
}

Bir sonraki adımda kullanmanız gereken şablon kimliğini not edin, bu durumda: abc86b82-029a-4b74-9690-4ab607f3eafe

Adım 2: Seçilen şablona dayalı yeni bir rapor oluşturun

Komut: POST /insights/learnings/report_requests

Bu örnekte, bu istekte template_id olarak abc86b82-029a-4b74-9690-4ab607f3eafe gönderdiğinizden emin olun.

Örnek Yanıt:

{
  "data": {
    **"id": "abc23922-940d-4d6d-a6f0-ecaed00810c4"**,
    "status": "started",
    "created_at": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.051Z",
    "url": null,
    "template": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "Rapor Testi",
      "description": "Genel API amacı için test",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.06885+01:00"
    }
  }
}

Lütfen url için bir değerin henüz mevcut olmadığını unutmayın. Rapora ne kadar veri girdiğine bağlı olarak, bir rapor oluşturmak birkaç dakika sürebilir. Bir sonraki adımda raporunuzun URL' sini talep edeceksiniz.

Adım 3: Excel rapor dosyasının URL'sini alın

Komut: GET /insights/learnings/report_requests/{id}

Adım 2'deki yanıtta veri için kimliği kullandığınızdan emin olun, şablon için kimliği değil!

Örnek Yanıt:

{
  "data": {
    "id": "abc23922-940d-4d6d-a6f0-ecaed00810c4",
    "status": "done",
    "created_at": "2022-03-03T08:48:46.051Z",
    "updated_at": "2022-03-03T08:48:46.839Z",
    **"url": "<https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de>"**,
    "şablon": {
      "id": "abc86b82-029a-4b74-9690-4ab607f3eafe",
      "name": "Rapor Testi",
      "description": "Genel API amacı için test",
      "created_at": "2022-03-01T15:36:42.99789+01:00",
      "updated_at": "2022-03-03T09:48:46.70689+01:00"
    }
  }
}

Bu isteği, url için bir değer içeren bir yanıt alana kadar her 30 saniyede bir yinelenen bir şekilde çalıştırmanız gerekebilir. Bunun ne kadar süreceği, raporu oluşturmak için ne kadar veri gerektiğine bağlıdır.

Bu örnekte url https://motimate-reports-production.s3.eu-west-1.amazonaws.com/abc883af5017bcb49a6b99e71b01a0660b8f5204/report-test_1646297326.xlsx?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ABCAYLEQ6WVKO52OZP5X%2F20220303%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Date=20220303T085426Z&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=abc3806250e855b83fc121ea181764cc6df64481c63371004a27229acbaf98de

Bu URL'ye eriştiğinizde raporlarınız .xlxs Excel dosyası olarak indirilecektir. Şu anda verileri .csv gibi başka dosya formatlarında çıkarmak mümkün değildir.

Lütfen dikkat: Dosya 10 dakika sonra sona erecektir ve bundan önce indirilmelidir.

ℹ️ Bir rapor şablonu, yalnızca seçilen Gruplar ve Kullanıcılar hakkındaki verilere sınırlı erişimi olan bir Grup Yöneticisi tarafından oluşturulmuşsa, Motimate Public API kullanılırken bu kısıtlama yine de geçerli olacaktır.